org.checkerframework.qualframework.poly

Class PolyQual<Q>

java.lang.Object

org.checkerframework.qualframework.poly.PolyQual<Q>

Direct Known Subclasses:

PolyQual.Combined, PolyQual.GroundQual, PolyQual.QualVar

public abstract class PolyQual<Q>
extends Object

A qualifier in the qualifier polymorphism system, with ground qualifier representation Q. A PolyQual<Q> represents either a qualifier from the original system (GroundQual, which simply wraps a Q), a qualifier variable that ranges over ground qualifiers (QualVar), or a combination of two or more qualifiers using a CombiningOperation (Combined).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PolyQual.Combined<Q> A combination of several qualifiers and qualifier variables, using a combining function.
static class	PolyQual.GroundQual<Q> A wrapped qualifier from the underlying system.
static class	PolyQual.QualVar<Q> A qualifier variable.

Constructor Summary

Constructors

Constructor and Description
PolyQual()

Method Summary

Modifier and Type	Method and Description
abstract PolyQual.Combined<Q>	asCombined(CombiningOperation<Q> op) Convert this qualifier to an equivalent PolyQual.Combined qualifier using the given CombiningOperation.
PolyQual<Q>	combineWith(PolyQual<Q> other, CombiningOperation<Q> op) Combine this qualifier with another using the given CombiningOperation.
abstract Q	getMaximum() Get the least upper bound of the possible types of this qualifier under all valid assignments to qualifier variables.
abstract Q	getMinimum() Get the greatest lower bound of the possible types of this qualifier under all valid assignments to qualifier variables.
abstract PolyQual<Q>	substitute(Map<String,PolyQual<Q>> substs) Substitute qualifiers for qualifier variables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolyQual

public PolyQual()

Method Detail

getMinimum

public abstract Q getMinimum()

Get the greatest lower bound of the possible types of this qualifier under all valid assignments to qualifier variables. (That is, for all assignments of qualifiers to qualifier variables, pq.getMinimum() is a subtype of pq.

getMaximum

public abstract Q getMaximum()

Get the least upper bound of the possible types of this qualifier under all valid assignments to qualifier variables.

substitute

public abstract PolyQual<Q> substitute(Map<String,PolyQual<Q>> substs)

Substitute qualifiers for qualifier variables.

asCombined

public abstract PolyQual.Combined<Q> asCombined(CombiningOperation<Q> op)

Convert this qualifier to an equivalent PolyQual.Combined qualifier using the given CombiningOperation.

combineWith

public PolyQual<Q> combineWith(PolyQual<Q> other,
                               CombiningOperation<Q> op)

Combine this qualifier with another using the given CombiningOperation.