checkers.nullness

Class NullnessAnnotatedTypeFactory

@NonNull java.lang.Object

checkers.types.AnnotatedTypeFactory

checkers.types.BasicAnnotatedTypeFactory<NullnessSubchecker>

checkers.nullness.NullnessAnnotatedTypeFactory

public class NullnessAnnotatedTypeFactory
extends BasicAnnotatedTypeFactory<NullnessSubchecker>

Adds the NonNull annotation to a type that is:

1. (*) all literals (except for null literal)
2. (*) all primitive types
3. (*) an array-creation expression (with new)
4. (*) an object-creation expression (with new)
5. (*) a package declaration
6. in the scope of a DefaultQualifier annotation and matches its location criteria
7. determined to be NonNull by flow-sensitive inference
8. the class in a static member access (e.g., "System" in "System.out")
9. an exception parameter
10. the receiver type of a non-static (and non-constructor) method

Adds the Raw annotation to

11. the receiver type of constructors.

Additionally, the type factory will add the Nullable annotation to a type if the input is

12. (*) the null literal
13. of type Void,
14. may resolve the types of some NonNull fields as Nullable depending on the presence of a Raw annotation on a constructor or method receiver. Please review the Checker Framework for Raw semantics.

Implementation detail: (*) cases are handled by a meta-annotation rather than by code in this class.

Nested Class Summary

Nested classes/interfaces inherited from class checkers.types.AnnotatedTypeFactory

AnnotatedTypeFactory.InheritedFromClassAnnotator

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable AnnotationMirror	LAZYNONNULL Represents the Nullness Checker qualifiers
protected @Nullable AnnotationMirror	NONNULL Represents the Nullness Checker qualifiers
protected @Nullable AnnotationMirror	NULLABLE Represents the Nullness Checker qualifiers
protected @Nullable AnnotationMirror	POLYALL Represents the Nullness Checker qualifiers
protected @Nullable AnnotationMirror	POLYNULL Represents the Nullness Checker qualifiers
protected @Nullable AnnotationMirror	PRIMITIVE Represents the Nullness Checker qualifiers
protected @Nullable AnnotationMirror	RAW Represents the Nullness Checker qualifiers
protected @Nullable AnnotationMirror	UNUSED Represents the Nullness Checker qualifiers

Fields inherited from class checkers.types.BasicAnnotatedTypeFactory

checker, defaults, flow, FLOW_BY_DEFAULT, poly, treeAnnotator, typeAnnotator, useFlow

Fields inherited from class checkers.types.AnnotatedTypeFactory

annotations, atypes, elements, env, fromTreeCache, qualHierarchy, root, trees, types, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
NullnessAnnotatedTypeFactory(NullnessSubchecker checker, RawnessSubchecker rawnesschecker, @Nullable CompilationUnitTree root) Creates a NullnessAnnotatedTypeFactory.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	annotateImplicit(@Nullable Element elt, @Mutable AnnotatedTypeMirror type) Adds implicit annotations to a type obtained from a Element.
protected void	annotateImplicit(@Nullable Tree tree, @Mutable AnnotatedTypeMirror type, boolean iUseFlow)
Pair<AnnotatedTypeMirror.AnnotatedExecutableType,List<@Mutable AnnotatedTypeMirror>>	constructorFromUse(NewClassTree tree) Determines the AnnotatedTypeMirror.AnnotatedExecutableType of a constructor invocation.
protected Flow	createFlow(NullnessSubchecker checker, @Nullable CompilationUnitTree root, Set<@Nullable AnnotationMirror> flowQuals) Returns a Flow instance that performs flow sensitive analysis to infer qualifiers on unqualified types.
protected Set<@Nullable AnnotationMirror>	createFlowQualifiers(NullnessSubchecker checker) Returns the set of annotations to be inferred in flow analysis
protected TreeAnnotator	createTreeAnnotator(NullnessSubchecker checker) Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.
protected TypeAnnotator	createTypeAnnotator(NullnessSubchecker checker) Returns a TypeAnnotator that adds annotations to a type based on the content of the type itself.
AnnotatedTypeMirror.AnnotatedDeclaredType	getEnclosingType(TypeElement element, @Nullable Tree tree) Determine the type of the most enclosing class of the given tree that is a subtype of the given element.
AnnotatedTypeMirror.AnnotatedDeclaredType	getSelfType(@Nullable Tree tree) Returns the type of this in the current location, which can be used if this has a special semantics (e.g.
Set<VariableElement>	initializedAfter(@Nullable MethodTree node)
Pair<AnnotatedTypeMirror.AnnotatedExecutableType,List<@Mutable AnnotatedTypeMirror>>	methodFromUse(MethodInvocationTree tree) Determines the type of the invoked method based on the passed method invocation tree.
protected void	postDirectSuperTypes(@Mutable AnnotatedTypeMirror type, List<? extends @Mutable AnnotatedTypeMirror> supertypes) A callback method for the AnnotatedTypeFactory subtypes to customize directSuperTypes().

Methods inherited from class checkers.types.BasicAnnotatedTypeFactory

annotateImplicit, getDefaultedAnnotatedType, postInit

Methods inherited from class checkers.types.AnnotatedTypeFactory

addAliasedAnnotation, aliasedAnnotation, annotateInheritedFromClass, canHaveAnnotatedTypeParameters, createLRUCache, declarationFromElement, fromClass, fromElement, fromElement, fromElement, fromExpression, fromMember, fromNewClass, fromTypeTree, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFromTypeTree, getBoxedType, getCurrentClassTree, getCurrentClassType, getCurrentMethodReceiver, getDeclAnnotation, getImplicitReceiverType, getPath, getQualifierHierarchy, getReceiverType, getUnboxedType, getVisitorState, isAnyEnclosingThisDeref, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, postAsMemberOf, toAnnotatedType, toString, typeVariablesFromUse, unify

Methods inherited from class java.lang.Object

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

Field Detail

NONNULL

protected final @Nullable AnnotationMirror NONNULL

Represents the Nullness Checker qualifiers

NULLABLE

protected final @Nullable AnnotationMirror NULLABLE

Represents the Nullness Checker qualifiers

LAZYNONNULL

protected final @Nullable AnnotationMirror LAZYNONNULL

Represents the Nullness Checker qualifiers

RAW

protected final @Nullable AnnotationMirror RAW

Represents the Nullness Checker qualifiers

PRIMITIVE

protected final @Nullable AnnotationMirror PRIMITIVE

Represents the Nullness Checker qualifiers

POLYNULL

protected final @Nullable AnnotationMirror POLYNULL

Represents the Nullness Checker qualifiers

POLYALL

protected final @Nullable AnnotationMirror POLYALL

Represents the Nullness Checker qualifiers

UNUSED

protected final @Nullable AnnotationMirror UNUSED

Represents the Nullness Checker qualifiers

Constructor Detail

NullnessAnnotatedTypeFactory

public NullnessAnnotatedTypeFactory(NullnessSubchecker checker,
                            RawnessSubchecker rawnesschecker,
                            @Nullable CompilationUnitTree root)

Creates a NullnessAnnotatedTypeFactory.

Method Detail

createFlow

protected Flow createFlow(NullnessSubchecker checker,
              @Nullable CompilationUnitTree root,
              Set<@Nullable AnnotationMirror> flowQuals)

Description copied from class: BasicAnnotatedTypeFactory

Returns a Flow instance that performs flow sensitive analysis to infer qualifiers on unqualified types.

Overrides:

createFlow in class BasicAnnotatedTypeFactory<NullnessSubchecker>

Parameters:

checker - the checker

root - the compilation unit associated with this factory

flowQuals - the qualifiers to infer

Returns:

the flow analysis class

createFlowQualifiers

protected Set<@Nullable AnnotationMirror> createFlowQualifiers(NullnessSubchecker checker)

Description copied from class: BasicAnnotatedTypeFactory

Returns the set of annotations to be inferred in flow analysis

Overrides:

createFlowQualifiers in class BasicAnnotatedTypeFactory<NullnessSubchecker>

createTreeAnnotator

protected TreeAnnotator createTreeAnnotator(NullnessSubchecker checker)

Description copied from class: BasicAnnotatedTypeFactory

Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree. Subclasses may override this method to specify more appriopriate TreeAnnotator

Overrides:

createTreeAnnotator in class BasicAnnotatedTypeFactory<NullnessSubchecker>

Returns:

a tree annotator

createTypeAnnotator

protected TypeAnnotator createTypeAnnotator(NullnessSubchecker checker)

Description copied from class: BasicAnnotatedTypeFactory

Returns a TypeAnnotator that adds annotations to a type based on the content of the type itself.

Overrides:

createTypeAnnotator in class BasicAnnotatedTypeFactory<NullnessSubchecker>

Returns:

a type annotator

annotateImplicit

protected void annotateImplicit(@Nullable Element elt,
                    @Mutable AnnotatedTypeMirror type)

Description copied from class: AnnotatedTypeFactory

Adds implicit annotations to a type obtained from a Element. By default, this method does nothing. Subclasses should use this method to implement implicit annotations specific to their type systems.

Overrides:

annotateImplicit in class BasicAnnotatedTypeFactory<NullnessSubchecker>

Parameters:

elt - an element

type - the type obtained from elt

annotateImplicit

protected void annotateImplicit(@Nullable Tree tree,
                    @Mutable AnnotatedTypeMirror type,
                    boolean iUseFlow)

Overrides:

annotateImplicit in class BasicAnnotatedTypeFactory<NullnessSubchecker>

getSelfType

public AnnotatedTypeMirror.AnnotatedDeclaredType getSelfType(@Nullable Tree tree)

Description copied from class: AnnotatedTypeFactory

Returns the type of this in the current location, which can be used if this has a special semantics (e.g. this is non-null). The parameter is an arbitrary tree and does not have to mention "this", neither explicitly nor implicitly. This method should be overridden for type-system specific behavior. TODO: in 1.3, handle all receiver type annotations. TODO: handle enclosing classes correctly.

Overrides:

getSelfType in class AnnotatedTypeFactory

getEnclosingType

public final AnnotatedTypeMirror.AnnotatedDeclaredType getEnclosingType(TypeElement element,
                                                         @Nullable Tree tree)

Description copied from class: AnnotatedTypeFactory

Determine the type of the most enclosing class of the given tree that is a subtype of the given element. Receiver type annotations of an enclosing method are considered.

Overrides:

getEnclosingType in class AnnotatedTypeFactory

postDirectSuperTypes

protected void postDirectSuperTypes(@Mutable AnnotatedTypeMirror type,
                        List<? extends @Mutable AnnotatedTypeMirror> supertypes)

Description copied from class: AnnotatedTypeFactory

A callback method for the AnnotatedTypeFactory subtypes to customize directSuperTypes(). Overriding methods should merely change the annotations on the supertypes, without adding or removing new types. The default provided implementation adds type annotations to supertypes. This allows the type and its supertypes to have the qualifiers, e.g. the supertypes of an Immutable type are also Immutable.

Overrides:

postDirectSuperTypes in class BasicAnnotatedTypeFactory<NullnessSubchecker>

Parameters:

type - the type whose supertypes are desired

supertypes - the supertypes as specified by the base AnnotatedTypeFactory

methodFromUse

public Pair<AnnotatedTypeMirror.AnnotatedExecutableType,List<@Mutable AnnotatedTypeMirror>> methodFromUse(MethodInvocationTree tree)

Description copied from class: AnnotatedTypeFactory

Determines the type of the invoked method based on the passed method invocation tree. The returned method type has all type variables resolved, whether based on receiver type, passed type parameters if any, and method invocation parameter. Subclasses may override this method to customize inference of types or qualifiers based on method invocation parameters. As an implementation detail, this method depends on AnnotatedTypes.asMemberOf(AnnotatedTypeMirror, Element), and customization based on receiver type should be in accordance to its specification. The return type is a pair of the type of the invoked method and the (inferred) type arguments. Note that neither the explicitly passed nor the inferred type arguments are guaranteed to be subtypes of the corresponding upper bounds. See method BaseTypeVisitor.checkTypeArguments(Tree, List, List, List) for the checks of type argument well-formedness.

Overrides:

methodFromUse in class BasicAnnotatedTypeFactory<NullnessSubchecker>

Parameters:

tree - the method invocation tree

Returns:

the method type being invoked with tree and the (inferred) type arguments

constructorFromUse

public Pair<AnnotatedTypeMirror.AnnotatedExecutableType,List<@Mutable AnnotatedTypeMirror>> constructorFromUse(NewClassTree tree)

Description copied from class: AnnotatedTypeFactory

Determines the AnnotatedTypeMirror.AnnotatedExecutableType of a constructor invocation. Note that this is different than calling AnnotatedTypeFactory.getAnnotatedType(Tree) or AnnotatedTypeFactory.fromExpression(ExpressionTree) on the constructor invocation; those determine the type of the result of invoking the constructor, which is probably an AnnotatedTypeMirror.AnnotatedDeclaredType. TODO: Should the result of getAnnotatedType be the return type from the AnnotatedExecutableType computed here?

Overrides:

constructorFromUse in class BasicAnnotatedTypeFactory<NullnessSubchecker>

Parameters:

tree - the constructor invocation tree

Returns:

the annotated type of the invoked constructor (as an executable type) and the (inferred) type arguments

initializedAfter

public Set<VariableElement> initializedAfter(@Nullable MethodTree node)