org.checkerframework.qualframework.poly

Class QualifierParameterTypeFactory<Q>

java.lang.Object

org.checkerframework.qualframework.base.DefaultQualifiedTypeFactory<QualParams<Q>>

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

All Implemented Interfaces:

QualifiedTypeFactory<QualParams<Q>>

Direct Known Subclasses:

RegexQualifiedTypeFactory, TaintingQualifiedTypeFactory

public abstract class QualifierParameterTypeFactory<Q>
extends DefaultQualifiedTypeFactory<QualParams<Q>>

Type factory with qualifier polymorphism support. This type factory extends an underlying qualifier system with qualifier variables, combined qualifiers (using CombiningOperation), wildcards, typechecking support for all of the above, substitution for accessing fields whose types refer to qualifier parameters, and qualifier inference for method qualifier parameters.

Constructor Summary

Constructors

Constructor and Description
QualifierParameterTypeFactory(QualifierContext<QualParams<Q>> context)

Method Summary

Modifier and Type	Method and Description
protected abstract QualifierParameterAnnotationConverter<Q>	createAnnotationConverter() Constructs an AnnotationConverter for the current type system.
protected abstract QualifierHierarchy<Q>	createGroundQualifierHierarchy() Create a QualifierHierarchy for ground qualifiers (represented by instances of Q).
protected QualifierHierarchy<QualParams<Q>>	createQualifierHierarchy() Constructs a QualifierHierarchy for the current type system.
protected QualifierParameterTreeAnnotator<Q>	createTreeAnnotator() Constructs the TreeAnnotator to be used by this type factory.
protected QualifierParameterTypeAnnotator<Q>	createTypeAnnotator() Constructs the TypeAnnotator to be used by this type factory.
QualifierParameterAnnotationConverter<Q>	getAnnotationConverter() Gets the AnnotationConverter for the current type system.
QualifierHierarchy<Q>	getGroundQualifierHierarchy() Get the ground qualifier hierarchy used by this type system.
Pair<QualifiedTypeMirror.QualifiedExecutableType<QualParams<Q>>,List<QualifiedTypeMirror<QualParams<Q>>>>	methodFromUse(ExpressionTree tree, ExecutableElement methodElt, QualifiedTypeMirror<QualParams<Q>> receiverType)
QualifiedTypeMirror<QualParams<Q>>	postAsMemberOf(QualifiedTypeMirror<QualParams<Q>> memberType, QualifiedTypeMirror<QualParams<Q>> receiverType, Element memberElement) Hook for customizing the behavior of asMemberOf.
List<QualifiedTypeMirror<QualParams<Q>>>	postDirectSuperTypes(QualifiedTypeMirror<QualParams<Q>> subtype, List<? extends QualifiedTypeMirror<QualParams<Q>>> supertypes) Hook for customizing the behavior of directSuperTypes.

Methods inherited from class org.checkerframework.qualframework.base.DefaultQualifiedTypeFactory

computeQualifiedTypeParameterBounds, constructorFromUse, createFlowAnalysis, createQualifiedTypes, createTypeHierarchy, createTypeVariableSubstitutor, getContext, getDeclAnnotations, getDecoratedElement, getPath, getQualifiedType, getQualifiedType, getQualifiedTypeFromTypeTree, getQualifiedTypeParameterBounds, getQualifiedTypes, getQualifierHierarchy, getReceiverType, getTypeHierarchy, methodFromUse

Methods inherited from class java.lang.Object

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

Constructor Detail

QualifierParameterTypeFactory

public QualifierParameterTypeFactory(QualifierContext<QualParams<Q>> context)

Method Detail

createAnnotationConverter

protected abstract QualifierParameterAnnotationConverter<Q> createAnnotationConverter()

Description copied from class: DefaultQualifiedTypeFactory

Constructs an AnnotationConverter for the current type system. Every checker must override this method to return an appropriate AnnotationConverter subclass for that checker.

Specified by:

createAnnotationConverter in class DefaultQualifiedTypeFactory<QualParams<Q>>

getAnnotationConverter

public QualifierParameterAnnotationConverter<Q> getAnnotationConverter()

Description copied from class: DefaultQualifiedTypeFactory

Gets the AnnotationConverter for the current type system.

Overrides:

getAnnotationConverter in class DefaultQualifiedTypeFactory<QualParams<Q>>

createGroundQualifierHierarchy

protected abstract QualifierHierarchy<Q> createGroundQualifierHierarchy()

Create a QualifierHierarchy for ground qualifiers (represented by instances of Q).

getGroundQualifierHierarchy

public QualifierHierarchy<Q> getGroundQualifierHierarchy()

Get the ground qualifier hierarchy used by this type system.

createQualifierHierarchy

protected QualifierHierarchy<QualParams<Q>> createQualifierHierarchy()

Description copied from class: DefaultQualifiedTypeFactory

Constructs a QualifierHierarchy for the current type system. Every checker must override this method to return an appropriate QualifierHierarchy subclass for that checker.

Specified by:

createQualifierHierarchy in class DefaultQualifiedTypeFactory<QualParams<Q>>

createTypeAnnotator

protected QualifierParameterTypeAnnotator<Q> createTypeAnnotator()

Description copied from class: DefaultQualifiedTypeFactory

Constructs the TypeAnnotator to be used by this type factory. Checkers that need custom TypeAnnotator behavior should override this method to return an instance of their custom TypeAnnotator subclass.

Overrides:

createTypeAnnotator in class DefaultQualifiedTypeFactory<QualParams<Q>>

createTreeAnnotator

protected QualifierParameterTreeAnnotator<Q> createTreeAnnotator()

Description copied from class: DefaultQualifiedTypeFactory

Constructs the TreeAnnotator to be used by this type factory. Checkers that need custom TreeAnnotator behavior should override this method to return an instance of their custom TreeAnnotator subclass.

Overrides:

createTreeAnnotator in class DefaultQualifiedTypeFactory<QualParams<Q>>

postAsMemberOf

public QualifiedTypeMirror<QualParams<Q>> postAsMemberOf(QualifiedTypeMirror<QualParams<Q>> memberType,
                                                         QualifiedTypeMirror<QualParams<Q>> receiverType,
                                                         Element memberElement)

Description copied from interface: QualifiedTypeFactory

Hook for customizing the behavior of asMemberOf.

Specified by:

postAsMemberOf in interface QualifiedTypeFactory<QualParams<Q>>

Overrides:

postAsMemberOf in class DefaultQualifiedTypeFactory<QualParams<Q>>

Parameters:

memberType - the type of the element being accessed, according to the default asMemberOf implementation

receiverType - the type of the object instance whose element is being accessed

memberElement - the element being accessed

Returns:

a copy of memberType after applying checker-specific adjustments

methodFromUse

public Pair<QualifiedTypeMirror.QualifiedExecutableType<QualParams<Q>>,List<QualifiedTypeMirror<QualParams<Q>>>> methodFromUse(ExpressionTree tree,
                                                                                                                               ExecutableElement methodElt,
                                                                                                                               QualifiedTypeMirror<QualParams<Q>> receiverType)

Specified by:

methodFromUse in interface QualifiedTypeFactory<QualParams<Q>>

Overrides:

methodFromUse in class DefaultQualifiedTypeFactory<QualParams<Q>>

See Also:

QualifiedTypeFactory.methodFromUse(MethodInvocationTree)

postDirectSuperTypes

public List<QualifiedTypeMirror<QualParams<Q>>> postDirectSuperTypes(QualifiedTypeMirror<QualParams<Q>> subtype,
                                                                     List<? extends QualifiedTypeMirror<QualParams<Q>>> supertypes)

Description copied from interface: QualifiedTypeFactory

Hook for customizing the behavior of directSuperTypes.

Specified by:

postDirectSuperTypes in interface QualifiedTypeFactory<QualParams<Q>>

Overrides:

postDirectSuperTypes in class DefaultQualifiedTypeFactory<QualParams<Q>>

Parameters:

subtype - the target of the directSuperTypes call

supertypes - the supertypes produced by the default directSuperTypes implementation

Returns:

a copy of supertypes after applying checker-specific adjustments