org.checkerframework.qualframework.base

Class QualifiedTypeMirror<Q>

java.lang.Object

org.checkerframework.qualframework.base.QualifiedTypeMirror<Q>

Direct Known Subclasses:

QualifiedTypeMirror.QualifiedArrayType, QualifiedTypeMirror.QualifiedDeclaredType, QualifiedTypeMirror.QualifiedExecutableType, QualifiedTypeMirror.QualifiedIntersectionType, QualifiedTypeMirror.QualifiedNoType, QualifiedTypeMirror.QualifiedNullType, QualifiedTypeMirror.QualifiedParameterDeclaration, QualifiedTypeMirror.QualifiedPrimitiveType, QualifiedTypeMirror.QualifiedTypeDeclaration, QualifiedTypeMirror.QualifiedTypeVariable, QualifiedTypeMirror.QualifiedUnionType, QualifiedTypeMirror.QualifiedWildcardType

public abstract class QualifiedTypeMirror<Q>
extends Object

A ExtendedTypeMirror with a qualifier for the top level and for each component of the type. For example, the qualified version of int[] has one qualifier on the top-level QualifiedTypeMirror.QualifiedArrayType and another on the QualifiedTypeMirror.QualifiedPrimitiveType representing int. A QualifiedTypeMirror is immutable and always has exactly one non-null qualifier. In addition, the structure of the QualifiedTypeMirror always matches the structure of the underlying ExtendedTypeMirror. That is, for any type with components (such as DeclaredType, which has a list of type arguments as a component), it will always be the case that qtm.getUnderlyingType().getComponent() is equivalent to qtm.getComponent().getUnderlyingType() according to Object.equals.

See Also:

QualifiedTypeFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QualifiedTypeMirror.QualifiedArrayType<Q>
static class	QualifiedTypeMirror.QualifiedDeclaredType<Q>
static class	QualifiedTypeMirror.QualifiedExecutableType<Q>
static class	QualifiedTypeMirror.QualifiedIntersectionType<Q>
static class	QualifiedTypeMirror.QualifiedNoType<Q>
static class	QualifiedTypeMirror.QualifiedNullType<Q>
static class	QualifiedTypeMirror.QualifiedParameterDeclaration<Q>
static class	QualifiedTypeMirror.QualifiedPrimitiveType<Q>
static class	QualifiedTypeMirror.QualifiedTypeDeclaration<Q>
static class	QualifiedTypeMirror.QualifiedTypeVariable<Q>
static class	QualifiedTypeMirror.QualifiedUnionType<Q>
static class	QualifiedTypeMirror.QualifiedWildcardType<Q>

Method Summary

Modifier and Type	Method and Description
abstract <R,P> R	accept(QualifiedTypeVisitor<Q,R,P> visitor, P p) Applies a QualifiedTypeVisitor to this qualified type.
boolean	equals(Object obj)
TypeKind	getKind() Gets the TypeKind of the underlying type.
Q	getQualifier() Gets the qualifier in the main qualifier position of this type.
ExtendedTypeMirror	getUnderlyingType() Gets the underlying ExtendedTypeMirror.
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

accept

public abstract <R,P> R accept(QualifiedTypeVisitor<Q,R,P> visitor,
                               P p)

Applies a QualifiedTypeVisitor to this qualified type.

getUnderlyingType

public ExtendedTypeMirror getUnderlyingType()

Gets the underlying ExtendedTypeMirror.

getKind

public final TypeKind getKind()

Gets the TypeKind of the underlying type.

getQualifier

public final Q getQualifier()

Gets the qualifier in the main qualifier position of this type.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object