org.checkerframework.qualframework.poly

Class QualifierParameterHierarchy<Q>

java.lang.Object

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

All Implemented Interfaces:

QualifierHierarchy<QualParams<Q>>

public class QualifierParameterHierarchy<Q>
extends Object
implements QualifierHierarchy<QualParams<Q>>

This class provides a QualifierHierarchy implementation for sets of qualifier parameters. Under this hierarchy, A is a subtype of B iff the value of each qualifier parameter in A is contained within the value of the corresponding parameter in B.

Field Summary

Fields

Modifier and Type	Field and Description
QualParams<Q>	PARAMS_BOTTOM
QualParams<Q>	PARAMS_TOP

Constructor Summary

Constructors

Constructor and Description
QualifierParameterHierarchy(QualifierHierarchy<Wildcard<Q>> containmentHierarchy, QualifierHierarchy<PolyQual<Q>> polyQualHierarchy)

Method Summary

Modifier and Type	Method and Description
static <Q> QualifierParameterHierarchy<Q>	fromContainment(QualifierHierarchy<Wildcard<Q>> containmentHierarchy, QualifierHierarchy<PolyQual<Q>> polyQualHierarchy) Construct an instance from a ContainmentHierarchy or equivalent.
static <Q> QualifierParameterHierarchy<Q>	fromGround(QualifierHierarchy<Q> groundHierarchy) Construct an instance from a QualifierHierarchy<Q>, using the default PolyQualHierarchy and ContainmentHierarchy implementations.
static <Q> QualifierParameterHierarchy<Q>	fromPolyQual(QualifierHierarchy<PolyQual<Q>> polyQualHierarchy) Construct an instance from a PolyQualHierarchy or equivalent, using the default ContainmentHierarchy implementation.
QualParams<Q>	getBottom() Gets the bottom annotation of the hierarchy.
protected QualifierHierarchy<Wildcard<Q>>	getContaintmentHierarchy() Get the containment hierarchy that is used to compare wildcards.
QualParams<Q>	getTop() Gets the top annotation of the hierarchy.
QualParams<Q>	greatestLowerBound(QualParams<Q> a, QualParams<Q> b) Gets the greatest lower bound of two qualifiers.
boolean	isSubtype(QualParams<Q> subtype, QualParams<Q> supertype) Checks if subtype is a subtype of supertype.
QualParams<Q>	leastUpperBound(QualParams<Q> a, QualParams<Q> b) Gets the least upper bound of two qualifiers.
void	setConstraintTarget(List<Pair<Wildcard<Q>,Wildcard<Q>>> constraintTarget) Set a target for constraint generation.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS_BOTTOM

public QualParams<Q> PARAMS_BOTTOM

PARAMS_TOP

public QualParams<Q> PARAMS_TOP

Constructor Detail

QualifierParameterHierarchy

public QualifierParameterHierarchy(QualifierHierarchy<Wildcard<Q>> containmentHierarchy,
                                   QualifierHierarchy<PolyQual<Q>> polyQualHierarchy)

Method Detail

fromContainment

public static <Q> QualifierParameterHierarchy<Q> fromContainment(QualifierHierarchy<Wildcard<Q>> containmentHierarchy,
                                                                 QualifierHierarchy<PolyQual<Q>> polyQualHierarchy)

Construct an instance from a ContainmentHierarchy or equivalent.

fromPolyQual

public static <Q> QualifierParameterHierarchy<Q> fromPolyQual(QualifierHierarchy<PolyQual<Q>> polyQualHierarchy)

Construct an instance from a PolyQualHierarchy or equivalent, using the default ContainmentHierarchy implementation.

fromGround

public static <Q> QualifierParameterHierarchy<Q> fromGround(QualifierHierarchy<Q> groundHierarchy)

Construct an instance from a QualifierHierarchy<Q>, using the default PolyQualHierarchy and ContainmentHierarchy implementations.

getContaintmentHierarchy

protected QualifierHierarchy<Wildcard<Q>> getContaintmentHierarchy()

Get the containment hierarchy that is used to compare wildcards.

setConstraintTarget

public void setConstraintTarget(List<Pair<Wildcard<Q>,Wildcard<Q>>> constraintTarget)

Set a target for constraint generation. When the current constraint target is not null, all subtyping checks return true and populate the target with a (subtype, supertype) pair for each containment check that would normally be made.

isSubtype

public boolean isSubtype(QualParams<Q> subtype,
                         QualParams<Q> supertype)

Description copied from interface: QualifierHierarchy

Checks if subtype is a subtype of supertype.

Specified by:

isSubtype in interface QualifierHierarchy<QualParams<Q>>

leastUpperBound

public QualParams<Q> leastUpperBound(QualParams<Q> a,
                                     QualParams<Q> b)

Description copied from interface: QualifierHierarchy

Gets the least upper bound of two qualifiers.

Specified by:

leastUpperBound in interface QualifierHierarchy<QualParams<Q>>

greatestLowerBound

public QualParams<Q> greatestLowerBound(QualParams<Q> a,
                                        QualParams<Q> b)

Description copied from interface: QualifierHierarchy

Gets the greatest lower bound of two qualifiers.

Specified by:

greatestLowerBound in interface QualifierHierarchy<QualParams<Q>>

getBottom

public QualParams<Q> getBottom()

Description copied from interface: QualifierHierarchy

Gets the bottom annotation of the hierarchy.

Specified by:

getBottom in interface QualifierHierarchy<QualParams<Q>>

getTop

public QualParams<Q> getTop()

Description copied from interface: QualifierHierarchy

Gets the top annotation of the hierarchy.

Specified by:

getTop in interface QualifierHierarchy<QualParams<Q>>