checkers.units

Class UnitsAnnotatedTypeFactory

@NonNull java.lang.Object

checkers.types.AnnotatedTypeFactory

checkers.types.BasicAnnotatedTypeFactory<UnitsChecker>

checkers.units.UnitsAnnotatedTypeFactory

public class UnitsAnnotatedTypeFactory
extends BasicAnnotatedTypeFactory<UnitsChecker>

Annotated type factory for the Units Checker. Handles multiple names for the same unit, with different prefixes, e.g. @kg is the same as @g(Prefix.kilo). Supports relations between units, e.g. if "m" is a variable of type "@m" and "s" is a variable of type "@s", the division "m/s" is automatically annotated as "mPERs", the correct unit for the result.

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	mixedUnits

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
UnitsAnnotatedTypeFactory(UnitsChecker checker, @Nullable CompilationUnitTree root)

Method Summary

Methods

Modifier and Type	Method and Description
@Nullable AnnotationMirror	aliasedAnnotation(@Nullable AnnotationMirror a) Returns the canonical annotation for the passed annotation if it is an alias of a canonical one in the framework.
protected TreeAnnotator	createTreeAnnotator(UnitsChecker checker) Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.

Methods inherited from class checkers.types.BasicAnnotatedTypeFactory

annotateImplicit, annotateImplicit, annotateImplicit, constructorFromUse, createFlow, createFlowQualifiers, createTypeAnnotator, getDefaultedAnnotatedType, methodFromUse, postDirectSuperTypes, postInit

Methods inherited from class checkers.types.AnnotatedTypeFactory

addAliasedAnnotation, 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, getEnclosingType, getImplicitReceiverType, getPath, getQualifierHierarchy, getReceiverType, getSelfType, 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

mixedUnits

protected final @Nullable AnnotationMirror mixedUnits

Constructor Detail

UnitsAnnotatedTypeFactory

public UnitsAnnotatedTypeFactory(UnitsChecker checker,
                         @Nullable CompilationUnitTree root)

Method Detail

aliasedAnnotation

public @Nullable AnnotationMirror aliasedAnnotation(@Nullable AnnotationMirror a)

Description copied from class: AnnotatedTypeFactory

Returns the canonical annotation for the passed annotation if it is an alias of a canonical one in the framework. If it is not an alias, the method returns null. Returns an aliased type of the current one

Overrides:

aliasedAnnotation in class AnnotatedTypeFactory

createTreeAnnotator

protected TreeAnnotator createTreeAnnotator(UnitsChecker 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<UnitsChecker>

Returns:

a tree annotator