Package org.checkerframework.framework.util

Class DefaultQualifierKindHierarchy.DefaultQualifierKind

java.lang.Object

org.checkerframework.framework.util.DefaultQualifierKindHierarchy.DefaultQualifierKind

All Implemented Interfaces:

java.lang.Comparable<QualifierKind>, QualifierKind

Enclosing class:

DefaultQualifierKindHierarchy

@AnnotatedFor("nullness")
@Interned
public static class DefaultQualifierKindHierarchy.DefaultQualifierKind
extends java.lang.Object
implements QualifierKind

The default implementation of QualifierKind.

The fields in this class that refer to QualifierKinds are set when creating the DefaultQualifierKindHierarchy. So the getter methods for these fields should not be called until after the DefaultQualifierKindHierarchy is created.

Field Summary

Fields

Modifier and Type	Field	Description
protected @MonotonicNonNull DefaultQualifierKindHierarchy.DefaultQualifierKind	bottom	The bottom of the hierarchy to which this belongs.
protected @Nullable DefaultQualifierKindHierarchy.DefaultQualifierKind	poly	The polymorphic qualifier of the hierarchy to which this belongs.
protected @MonotonicNonNull java.util.Set<QualifierKind>	strictSuperTypes	All the qualifier kinds that are a strict super qualifier kind of this.
protected @MonotonicNonNull DefaultQualifierKindHierarchy.DefaultQualifierKind	top	The top of the hierarchy to which this belongs.

Method Summary

Modifier and Type	Method	Description
java.lang.Class<? extends java.lang.annotation.Annotation>	getAnnotationClass()	Returns the annotation class for this.
QualifierKind	getBottom()	Returns the bottom qualifier kind of the hierarchy to which this qualifier kind belongs.
@Interned @CanonicalName java.lang.String	getName()	Returns the canonical name of the annotation class of this.
@Nullable QualifierKind	getPolymorphic()	Returns the polymorphic qualifier kind of the hierarchy to which this qualifier kind belongs, or null if one does not exist.
java.util.Set<? extends QualifierKind>	getStrictSuperTypes()	All the qualifier kinds that are a strict super qualifier of this qualifier.
QualifierKind	getTop()	Returns the top qualifier kind of the hierarchy to which this qualifier kind belongs.
boolean	hasElements()	Returns true if the annotation class this qualifier kind represents has annotation elements/arguments.
boolean	isBottom()	Returns true if this is the bottom qualifier of its hierarchy.
boolean	isInSameHierarchyAs(QualifierKind other)	Returns true if this and other are in the same hierarchy.
boolean	isPoly()	Returns true if this is polymorphic.
boolean	isSubtypeOf(QualifierKind superQualKind)	Returns true if this qualifier kind is a subtype of or equal to superQualKind.
boolean	isTop()	Returns true if this is the top qualifier of its hierarchy.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.checkerframework.framework.util.QualifierKind

compareTo

Field Detail

top

protected @MonotonicNonNull DefaultQualifierKindHierarchy.DefaultQualifierKind top

The top of the hierarchy to which this belongs.

bottom

protected @MonotonicNonNull DefaultQualifierKindHierarchy.DefaultQualifierKind bottom

The bottom of the hierarchy to which this belongs.

poly

protected @Nullable DefaultQualifierKindHierarchy.DefaultQualifierKind poly

The polymorphic qualifier of the hierarchy to which this belongs.

strictSuperTypes

protected @MonotonicNonNull java.util.Set<QualifierKind> strictSuperTypes

All the qualifier kinds that are a strict super qualifier kind of this. Does not include this qualifier kind itself.

Method Detail

getName

public @Interned @CanonicalName java.lang.String getName()

Description copied from interface: QualifierKind

Returns the canonical name of the annotation class of this.

Specified by:

getName in interface QualifierKind

Returns:

the canonical name of the annotation class of this

getAnnotationClass

public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationClass()

Description copied from interface: QualifierKind

Returns the annotation class for this.

Specified by:

getAnnotationClass in interface QualifierKind

Returns:

the annotation class for this

getTop

public QualifierKind getTop()

Description copied from interface: QualifierKind

Returns the top qualifier kind of the hierarchy to which this qualifier kind belongs.

Specified by:

getTop in interface QualifierKind

Returns:

the top qualifier kind of the hierarchy to which this qualifier kind belongs

isTop

public boolean isTop()

Description copied from interface: QualifierKind

Returns true if this is the top qualifier of its hierarchy.

Specified by:

isTop in interface QualifierKind

Returns:

true if this is the top qualifier of its hierarchy

getBottom

public QualifierKind getBottom()

Description copied from interface: QualifierKind

Returns the bottom qualifier kind of the hierarchy to which this qualifier kind belongs.

Specified by:

getBottom in interface QualifierKind

Returns:

the bottom qualifier kind of the hierarchy to which this qualifier kind belongs

isBottom

public boolean isBottom()

Description copied from interface: QualifierKind

Returns true if this is the bottom qualifier of its hierarchy.

Specified by:

isBottom in interface QualifierKind

Returns:

true if this is the bottom qualifier of its hierarchy

getPolymorphic

public @Nullable QualifierKind getPolymorphic()

Description copied from interface: QualifierKind

Returns the polymorphic qualifier kind of the hierarchy to which this qualifier kind belongs, or null if one does not exist.

Specified by:

getPolymorphic in interface QualifierKind

Returns:

the polymorphic qualifier kind of the hierarchy to which this qualifier kind belongs, or null if one does not exist

isPoly

@Pure
public boolean isPoly()

Description copied from interface: QualifierKind

Returns true if this is polymorphic.

Specified by:

isPoly in interface QualifierKind

Returns:

true if this is polymorphic

hasElements

public boolean hasElements()

Description copied from interface: QualifierKind

Returns true if the annotation class this qualifier kind represents has annotation elements/arguments.

Specified by:

hasElements in interface QualifierKind

Returns:

true if the annotation class this qualifier kind represents has elements/arguments

getStrictSuperTypes

public java.util.Set<? extends QualifierKind> getStrictSuperTypes()

Description copied from interface: QualifierKind

All the qualifier kinds that are a strict super qualifier of this qualifier. Does not include this qualifier kind itself.

Specified by:

getStrictSuperTypes in interface QualifierKind

Returns:

all the qualifier kinds that are a strict super qualifier of this qualifier

isInSameHierarchyAs

public boolean isInSameHierarchyAs(QualifierKind other)

Description copied from interface: QualifierKind

Returns true if this and other are in the same hierarchy.

Specified by:

isInSameHierarchyAs in interface QualifierKind

Parameters:

other - a qualifier kind

Returns:

true if this and other are in the same hierarchy

isSubtypeOf

public boolean isSubtypeOf(QualifierKind superQualKind)

Description copied from interface: QualifierKind

Returns true if this qualifier kind is a subtype of or equal to superQualKind.

Specified by:

isSubtypeOf in interface QualifierKind

Parameters:

superQualKind - other qualifier kind

Returns:

true if this qualifier kind is a subtype of or equal to superQualKind

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object