org.checkerframework.qualframework.base

Interface QualifiedTypeFactory<Q>

All Known Implementing Classes:

DefaultQualifiedTypeFactory, QualifierParameterTypeFactory, RegexQualifiedTypeFactory, RegexQualifiedTypeFactory, TaintingQualifiedTypeFactory, TaintingQualifiedTypeFactory

public interface QualifiedTypeFactory<Q>

Used to compute the qualified type of a Tree or Element. Also includes hooks that can be overridden to modify typechecking behavior in type system-specific ways.

Method Summary

Modifier and Type	Method and Description
Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>>	constructorFromUse(NewClassTree tree) Hook for customizing type parameter inference for constructors.
QualAnalysis<Q>	createFlowAnalysis(List<Pair<VariableElement,QualValue<Q>>> fieldValues) Create the Analysis to configure dataflow.
TypeVariableSubstitutor<Q>	createTypeVariableSubstitutor()
Set<AnnotationMirror>	getDeclAnnotations(Element elt)
ExtendedTypeMirror	getDecoratedElement(Element element) Get an ExtendedTypeMirror for an Element that has all the Annotations that were located on the element in source code or in stub files.
TreePath	getPath(Tree node)
QualifiedTypeMirror<Q>	getQualifiedType(Element element) Gets the qualified type of an Element.
QualifiedTypeMirror<Q>	getQualifiedType(Tree tree) Gets the qualified type of an AST node.
QualifiedTypeMirror<Q>	getQualifiedTypeFromTypeTree(Tree typeTree) Gets the qualified type from a type in Tree form.
QualifiedTypeParameterBounds<Q>	getQualifiedTypeParameterBounds(ExtendedParameterDeclaration etm) Gets the qualified types of the bounds of a type parameter, identified by its Element.
QualifiedTypes<Q>	getQualifiedTypes() Gets the QualifiedTypes helper object used with this type system.
QualifierHierarchy<Q>	getQualifierHierarchy() Gets the QualifierHierarchy used with this type system.
QualifiedTypeMirror<Q>	getReceiverType(ExpressionTree expression) Returns the receiver type of the expression tree, or null if it does not exist.
TypeHierarchy<Q>	getTypeHierarchy() Gets the TypeHierarchy used with this type system.
Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>>	methodFromUse(ExpressionTree tree, ExecutableElement methodElt, QualifiedTypeMirror<Q> receiverType)
Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>>	methodFromUse(MethodInvocationTree tree) Hook for customizing type parameter inference for methods.
QualifiedTypeMirror<Q>	postAsMemberOf(QualifiedTypeMirror<Q> memberType, QualifiedTypeMirror<Q> receiverType, Element memberElement) Hook for customizing the behavior of asMemberOf.
List<QualifiedTypeMirror<Q>>	postDirectSuperTypes(QualifiedTypeMirror<Q> subtype, List<? extends QualifiedTypeMirror<Q>> supertypes) Hook for customizing the behavior of directSuperTypes.

Method Detail

getQualifiedType

QualifiedTypeMirror<Q> getQualifiedType(Element element)

Gets the qualified type of an Element.

getQualifiedType

QualifiedTypeMirror<Q> getQualifiedType(Tree tree)

Gets the qualified type of an AST node.

getQualifiedTypeFromTypeTree

QualifiedTypeMirror<Q> getQualifiedTypeFromTypeTree(Tree typeTree)

Gets the qualified type from a type in Tree form.

getQualifiedTypeParameterBounds

QualifiedTypeParameterBounds<Q> getQualifiedTypeParameterBounds(ExtendedParameterDeclaration etm)

Gets the qualified types of the bounds of a type parameter, identified by its Element.

getQualifierHierarchy

QualifierHierarchy<Q> getQualifierHierarchy()

Gets the QualifierHierarchy used with this type system.

getTypeHierarchy

TypeHierarchy<Q> getTypeHierarchy()

Gets the TypeHierarchy used with this type system.

getQualifiedTypes

QualifiedTypes<Q> getQualifiedTypes()

Gets the QualifiedTypes helper object used with this type system.

postDirectSuperTypes

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

Hook for customizing the behavior of directSuperTypes.

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

postAsMemberOf

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

Hook for customizing the behavior of asMemberOf.

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

Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>> methodFromUse(MethodInvocationTree tree)

Hook for customizing type parameter inference for methods.

Parameters:

tree - the AST node for the method call

Returns:

the type of the called method with all parameters instantiated, and a list of the type used to instantiate each parameter

methodFromUse

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

See Also:

methodFromUse(MethodInvocationTree)

constructorFromUse

Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>> constructorFromUse(NewClassTree tree)

Hook for customizing type parameter inference for constructors.

Parameters:

tree - the AST node for the constructor call

Returns:

the type of the called constructor with all parameters instantiated, and a list of the type used to instantiate each parameter

createFlowAnalysis

QualAnalysis<Q> createFlowAnalysis(List<Pair<VariableElement,QualValue<Q>>> fieldValues)

Create the Analysis to configure dataflow.

Parameters:

fieldValues - the initial field values

Returns:

the QualAnalysis to use

getPath

TreePath getPath(Tree node)

Parameters:

node - the @Tree to look up the TreePath for

Returns:

the TreePath

getReceiverType

QualifiedTypeMirror<Q> getReceiverType(ExpressionTree expression)

Returns the receiver type of the expression tree, or null if it does not exist. The only trees that could potentially have a receiver are:

• ArrayAccessTree
• IdentifierTree (whose receivers are usually self type)
• MethodInvocationTree
• MemberSelectTree

Parameters:

expression - the expression for which to determine the receiver type

Returns:

the type of the receiver of this expression

getDecoratedElement

ExtendedTypeMirror getDecoratedElement(Element element)

Get an ExtendedTypeMirror for an Element that has all the Annotations that were located on the element in source code or in stub files.

Parameters:

element - the Element

Returns:

the ExtendedTypeMirror

createTypeVariableSubstitutor

TypeVariableSubstitutor<Q> createTypeVariableSubstitutor()

Returns:

a TypeVariableSubstitutor

getDeclAnnotations

Set<AnnotationMirror> getDeclAnnotations(Element elt)