DefaultQualifiedTypeFactory

java.lang.Object
- org.checkerframework.qualframework.base.DefaultQualifiedTypeFactory<Q>

All Implemented Interfaces:

QualifiedTypeFactory<Q>

Direct Known Subclasses:

QualifierParameterTypeFactory, RegexQualifiedTypeFactory, TaintingQualifiedTypeFactory
```
public abstract class DefaultQualifiedTypeFactory<Q>
extends Object
implements QualifiedTypeFactory<Q>
```
Default implementation of QualifiedTypeFactory. Most type systems should extend this class (or a subclass) instead of implementing QualifiedTypeFactory directly. This implementation decomposes the problem of type checking using several helper classes:
- AnnotationConverter: Converts annotations written in the source code into type qualifiers for use in type checking.
- TypeAnnotator: A visitor for ExtendedTypeMirrors that adds a qualifier to each component of the type, producing a QualifiedTypeMirror.
- TreeAnnotator: A visitor for Trees that computes the qualified type of each AST node based on the qualified types of its subnodes.
- QualifierHierarchy: Used to perform subtyping checks between two type qualifiers (independent of any Java types).
- TypeHierarchy: Used to perform subtyping checks between two QualifiedTypeMirrors.
Default implementations are available for TypeAnnotator, TreeAnnotator, and TypeHierarchy. The type system must provide implementations for AnnotationConverter and QualifierHierarchy.

Constructor Summary

Constructors
Constructor and Description

DefaultQualifiedTypeFactory(QualifierContext<Q> context)

Constructors
Constructor and Description
`DefaultQualifiedTypeFactory(QualifierContext<Q> context)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected QualifiedTypeParameterBounds<Q>`	`computeQualifiedTypeParameterBounds(ExtendedParameterDeclaration etm)` Computes the bounds of a type parameter.
`Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>>`	`constructorFromUse(NewClassTree tree)` Hook for customizing type parameter inference for constructors.
`protected abstract AnnotationConverter<Q>`	`createAnnotationConverter()` Constructs an `AnnotationConverter` for the current type system.
`QualAnalysis<Q>`	`createFlowAnalysis(List<Pair<VariableElement,QualValue<Q>>> fieldValues)` Create the `Analysis` to configure dataflow.
`protected QualifiedTypes<Q>`	`createQualifiedTypes()`
`protected abstract QualifierHierarchy<Q>`	`createQualifierHierarchy()` Constructs a `QualifierHierarchy` for the current type system.
`protected TreeAnnotator<Q>`	`createTreeAnnotator()` Constructs the `TreeAnnotator` to be used by this type factory.
`protected TypeAnnotator<Q>`	`createTypeAnnotator()` Constructs the `TypeAnnotator` to be used by this type factory.
`protected TypeHierarchy<Q>`	`createTypeHierarchy(QualifierHierarchy<Q> qualifierHierarchy)` Constructs a `TypeHierarchy` for the current type system.
`TypeVariableSubstitutor<Q>`	`createTypeVariableSubstitutor()`
`AnnotationConverter<Q>`	`getAnnotationConverter()` Gets the `AnnotationConverter` for the current type system.
`QualifierContext<Q>`	`getContext()`
`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`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultQualifiedTypeFactory
```
public DefaultQualifiedTypeFactory(QualifierContext<Q> context)
```
- Method Detail
  - getQualifiedType
```
public final QualifiedTypeMirror<Q> getQualifiedType(Element element)
```
    Description copied from interface: QualifiedTypeFactory
    
    Gets the qualified type of an Element.
    
    Specified by:
    
    getQualifiedType in interface QualifiedTypeFactory<Q>
  - getQualifiedType
```
public final QualifiedTypeMirror<Q> getQualifiedType(Tree tree)
```
    Description copied from interface: QualifiedTypeFactory
    
    Gets the qualified type of an AST node.
    
    Specified by:
    
    getQualifiedType in interface QualifiedTypeFactory<Q>
  - getQualifiedTypeFromTypeTree
```
public final QualifiedTypeMirror<Q> getQualifiedTypeFromTypeTree(Tree typeTree)
```
    Description copied from interface: QualifiedTypeFactory
    
    Gets the qualified type from a type in Tree form.
    
    Specified by:
    
    getQualifiedTypeFromTypeTree in interface QualifiedTypeFactory<Q>
  - getQualifiedTypeParameterBounds
```
public final QualifiedTypeParameterBounds<Q> getQualifiedTypeParameterBounds(ExtendedParameterDeclaration etm)
```
    Description copied from interface: QualifiedTypeFactory
    
    Gets the qualified types of the bounds of a type parameter, identified by its Element.
    
    Specified by:
    
    getQualifiedTypeParameterBounds in interface QualifiedTypeFactory<Q>
  - computeQualifiedTypeParameterBounds
```
protected QualifiedTypeParameterBounds<Q> computeQualifiedTypeParameterBounds(ExtendedParameterDeclaration etm)
```
    Computes the bounds of a type parameter. The default implementation processes the type annotations of the upper and lower bounds using the TypeAnnotator.
  - createTreeAnnotator
```
protected TreeAnnotator<Q> createTreeAnnotator()
```
    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.
  - createTypeAnnotator
```
protected TypeAnnotator<Q> createTypeAnnotator()
```
    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.
  - getQualifiedTypes
```
public final QualifiedTypes<Q> getQualifiedTypes()
```
    Description copied from interface: QualifiedTypeFactory
    
    Gets the QualifiedTypes helper object used with this type system.
    
    Specified by:
    
    getQualifiedTypes in interface QualifiedTypeFactory<Q>
  - createQualifiedTypes
```
protected QualifiedTypes<Q> createQualifiedTypes()
```
  - getQualifierHierarchy
```
public QualifierHierarchy<Q> getQualifierHierarchy()
```
    Description copied from interface: QualifiedTypeFactory
    
    Gets the QualifierHierarchy used with this type system.
    
    Specified by:
    
    getQualifierHierarchy in interface QualifiedTypeFactory<Q>
  - createQualifierHierarchy
```
protected abstract QualifierHierarchy<Q> createQualifierHierarchy()
```
    Constructs a QualifierHierarchy for the current type system. Every checker must override this method to return an appropriate QualifierHierarchy subclass for that checker.
  - getTypeHierarchy
```
public TypeHierarchy<Q> getTypeHierarchy()
```
    Description copied from interface: QualifiedTypeFactory
    
    Gets the TypeHierarchy used with this type system.
    
    Specified by:
    
    getTypeHierarchy in interface QualifiedTypeFactory<Q>
  - createTypeHierarchy
```
protected TypeHierarchy<Q> createTypeHierarchy(QualifierHierarchy<Q> qualifierHierarchy)
```
    Constructs a TypeHierarchy for the current type system. The default implementation constructs a DefaultTypeHierarchy.
    
    Parameters:
    
    qualifierHierarchy - a reference to the QualifierHierarchy used by this type system
  - getAnnotationConverter
```
public AnnotationConverter<Q> getAnnotationConverter()
```
    Gets the AnnotationConverter for the current type system.
  - createAnnotationConverter
```
protected abstract AnnotationConverter<Q> createAnnotationConverter()
```
    Constructs an AnnotationConverter for the current type system. Every checker must override this method to return an appropriate AnnotationConverter subclass for that checker.
  - postDirectSuperTypes
```
public List<QualifiedTypeMirror<Q>> postDirectSuperTypes(QualifiedTypeMirror<Q> subtype,
                                                         List<? extends QualifiedTypeMirror<Q>> supertypes)
```
    Description copied from interface: QualifiedTypeFactory
    
    Hook for customizing the behavior of directSuperTypes.
    
    Specified by:
    
    postDirectSuperTypes in interface QualifiedTypeFactory<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
  - postAsMemberOf
```
public QualifiedTypeMirror<Q> postAsMemberOf(QualifiedTypeMirror<Q> memberType,
                                             QualifiedTypeMirror<Q> receiverType,
                                             Element memberElement)
```
    Description copied from interface: QualifiedTypeFactory
    
    Hook for customizing the behavior of asMemberOf.
    
    Specified by:
    
    postAsMemberOf in interface QualifiedTypeFactory<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<Q>,List<QualifiedTypeMirror<Q>>> methodFromUse(MethodInvocationTree tree)
```
    Description copied from interface: QualifiedTypeFactory
    
    Hook for customizing type parameter inference for methods.
    
    Specified by:
    
    methodFromUse in interface QualifiedTypeFactory<Q>
    
    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
```
public Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>> methodFromUse(ExpressionTree tree,
                                                                                                       ExecutableElement methodElt,
                                                                                                       QualifiedTypeMirror<Q> receiverType)
```
    Specified by:
    
    methodFromUse in interface QualifiedTypeFactory<Q>
    
    See Also:
    
    QualifiedTypeFactory.methodFromUse(MethodInvocationTree)
  - constructorFromUse
```
public Pair<QualifiedTypeMirror.QualifiedExecutableType<Q>,List<QualifiedTypeMirror<Q>>> constructorFromUse(NewClassTree tree)
```
    Description copied from interface: QualifiedTypeFactory
    
    Hook for customizing type parameter inference for constructors.
    
    Specified by:
    
    constructorFromUse in interface QualifiedTypeFactory<Q>
    
    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
```
public QualAnalysis<Q> createFlowAnalysis(List<Pair<VariableElement,QualValue<Q>>> fieldValues)
```
    Description copied from interface: QualifiedTypeFactory
    
    Create the Analysis to configure dataflow.
    
    Specified by:
    
    createFlowAnalysis in interface QualifiedTypeFactory<Q>
    
    Parameters:
    
    fieldValues - The initial field values
    
    Returns:
    
    The QualAnalysis to use
  - getContext
```
public QualifierContext<Q> getContext()
```
  - getPath
```
public TreePath getPath(Tree node)
```
    Specified by:
    
    getPath in interface QualifiedTypeFactory<Q>
    
    Parameters:
    
    node - The @Tree to look up the TreePath for
    
    Returns:
    
    The TreePath
  - getReceiverType
```
public QualifiedTypeMirror<Q> getReceiverType(ExpressionTree expression)
```
    Description copied from interface: QualifiedTypeFactory
    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
    Specified by:
    
    getReceiverType in interface QualifiedTypeFactory<Q>
    
    Parameters:
    
    expression - The expression for which to determine the receiver type
    
    Returns:
    
    the type of the receiver of this expression
  - getDecoratedElement
```
public ExtendedTypeMirror getDecoratedElement(Element element)
```
    Description copied from interface: QualifiedTypeFactory
    
    Get an ExtendedTypeMirror for an Element that has all the Annotations that were located on the element in source code or in stub files.
    
    Specified by:
    
    getDecoratedElement in interface QualifiedTypeFactory<Q>
    
    Parameters:
    
    element - The Element
    
    Returns:
    
    The ExtendedTypeMirror
  - createTypeVariableSubstitutor
```
public TypeVariableSubstitutor<Q> createTypeVariableSubstitutor()
```
    Specified by:
    
    createTypeVariableSubstitutor in interface QualifiedTypeFactory<Q>
    
    Returns:
    
    a TypeVariableSubstitutor
  - getDeclAnnotations
```
public Set<AnnotationMirror> getDeclAnnotations(Element elt)
```
    Specified by:
    
    getDeclAnnotations in interface QualifiedTypeFactory<Q>

Class DefaultQualifiedTypeFactory<Q>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultQualifiedTypeFactory

Method Detail

getQualifiedType

getQualifiedType

getQualifiedTypeFromTypeTree

getQualifiedTypeParameterBounds

computeQualifiedTypeParameterBounds

createTreeAnnotator

createTypeAnnotator

getQualifiedTypes

createQualifiedTypes

getQualifierHierarchy

createQualifierHierarchy

getTypeHierarchy

createTypeHierarchy

getAnnotationConverter

createAnnotationConverter

postDirectSuperTypes

postAsMemberOf

methodFromUse

methodFromUse

constructorFromUse

createFlowAnalysis

getContext

getPath

getReceiverType

getDecoratedElement

createTypeVariableSubstitutor

getDeclAnnotations