org.checkerframework.framework.type

Class DefaultInferredTypesApplier.InferredTypeApplyingVisitor

java.lang.Object

org.checkerframework.framework.type.visitor.AbstractAtmComboVisitor<Void,AnnotationMirror>

org.checkerframework.framework.type.DefaultInferredTypesApplier.InferredTypeApplyingVisitor

All Implemented Interfaces:

AtmComboVisitor<Void,AnnotationMirror>

Enclosing class:

DefaultInferredTypesApplier

protected static class DefaultInferredTypesApplier.InferredTypeApplyingVisitor
extends AbstractAtmComboVisitor<Void,AnnotationMirror>

Traverses type pairs, copies the annotations from the first type to the second (inferred type) Traversal is necessary to add annotations to the bounds of wildcards and type variables when the type to annotate is a wildcard or type variable.

Constructor Summary

Constructors

Constructor and Description
InferredTypeApplyingVisitor(QualifierHierarchy qualifierHierarchy, boolean omitSubtypingCheck)

Method Summary

Modifier and Type	Method and Description
protected void	applyPrimary(AnnotatedTypeMirror bound, AnnotationMirror anno)
protected Void	defaultAction(AnnotatedTypeMirror type, AnnotatedTypeMirror inferred, AnnotationMirror top) Called by the default implementation of every AbstractAtmComboVisitor visit method.
protected String	defaultErrorMessage(AnnotatedTypeMirror type, AnnotatedTypeMirror inferred, AnnotationMirror top) Formats type1, type2 and param into an error message used by all methods of AbstractAtmComboVisitor that are not overridden.
Void	visitTypevar_Typevar(AnnotatedTypeMirror.AnnotatedTypeVariable type, AnnotatedTypeMirror.AnnotatedTypeVariable inferred, AnnotationMirror top) For TypeVariables it is important that we both compare the primary annotation and bounds.
Void	visitTypevar_Wildcard(AnnotatedTypeMirror.AnnotatedTypeVariable type, AnnotatedTypeMirror.AnnotatedWildcardType inferred, AnnotationMirror top)
Void	visitWildcard_Typevar(AnnotatedTypeMirror.AnnotatedWildcardType type, AnnotatedTypeMirror.AnnotatedTypeVariable inferred, AnnotationMirror top)
Void	visitWildcard_Wildcard(AnnotatedTypeMirror.AnnotatedWildcardType type, AnnotatedTypeMirror.AnnotatedWildcardType inferred, AnnotationMirror top)

Methods inherited from class org.checkerframework.framework.type.visitor.AbstractAtmComboVisitor

visit, visitArray_Array, visitArray_Declared, visitArray_Executable, visitArray_Intersection, visitArray_None, visitArray_Null, visitArray_Primitive, visitArray_Typevar, visitArray_Union, visitArray_Wildcard, visitDeclared_Array, visitDeclared_Declared, visitDeclared_Executable, visitDeclared_Intersection, visitDeclared_None, visitDeclared_Null, visitDeclared_Primitive, visitDeclared_Typevar, visitDeclared_Union, visitDeclared_Wildcard, visitExecutable_Array, visitExecutable_Declared, visitExecutable_Executable, visitExecutable_Intersection, visitExecutable_None, visitExecutable_Null, visitExecutable_Primitive, visitExecutable_Typevar, visitExecutable_Union, visitExecutable_Wildcard, visitIntersection_Array, visitIntersection_Declared, visitIntersection_Executable, visitIntersection_Intersection, visitIntersection_None, visitIntersection_Null, visitIntersection_Primitive, visitIntersection_Typevar, visitIntersection_Union, visitIntersection_Wildcard, visitNone_Array, visitNone_Declared, visitNone_Executable, visitNone_Intersection, visitNone_None, visitNone_Null, visitNone_Primitive, visitNone_Union, visitNone_Wildcard, visitNull_Array, visitNull_Declared, visitNull_Executable, visitNull_Intersection, visitNull_None, visitNull_Null, visitNull_Primitive, visitNull_Typevar, visitNull_Union, visitNull_Wildcard, visitPrimitive_Array, visitPrimitive_Declared, visitPrimitive_Executable, visitPrimitive_Intersection, visitPrimitive_None, visitPrimitive_Null, visitPrimitive_Primitive, visitPrimitive_Typevar, visitPrimitive_Union, visitPrimitive_Wildcard, visitTypevar_Array, visitTypevar_Declared, visitTypevar_Executable, visitTypevar_Intersection, visitTypevar_None, visitTypevar_Null, visitTypevar_Primitive, visitTypevar_Union, visitUnion_Array, visitUnion_Declared, visitUnion_Executable, visitUnion_Intersection, visitUnion_None, visitUnion_Null, visitUnion_Primitive, visitUnion_Typevar, visitUnion_Union, visitUnion_Wildcard, visitWildcard_Array, visitWildcard_Declared, visitWildcard_Executable, visitWildcard_Intersection, visitWildcard_None, visitWildcard_Null, visitWildcard_Primitive, visitWildcard_Union

Methods inherited from class java.lang.Object

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

Constructor Detail

InferredTypeApplyingVisitor

public InferredTypeApplyingVisitor(QualifierHierarchy qualifierHierarchy,
                                   boolean omitSubtypingCheck)

Method Detail

defaultErrorMessage

protected String defaultErrorMessage(AnnotatedTypeMirror type,
                                     AnnotatedTypeMirror inferred,
                                     AnnotationMirror top)

Description copied from class: AbstractAtmComboVisitor

Formats type1, type2 and param into an error message used by all methods of AbstractAtmComboVisitor that are not overridden. Normally, this method should indicate that the given method (and therefore the given pair of type mirror classes) is not supported by this class.

Specified by:

defaultErrorMessage in class AbstractAtmComboVisitor<Void,AnnotationMirror>

Parameters:

type - the first AnnotatedTypeMirror parameter to the visit method called

inferred - the second AnnotatedTypeMirror parameter to the visit method called

top - subtype specific parameter passed to every visit method

Returns:

an error message

defaultAction

protected Void defaultAction(AnnotatedTypeMirror type,
                             AnnotatedTypeMirror inferred,
                             AnnotationMirror top)

Description copied from class: AbstractAtmComboVisitor

Called by the default implementation of every AbstractAtmComboVisitor visit method. This methodnS issues a runtime exception by default. In general, it should handle the case where a visit method has been called with a pair of type mirrors that should never be passed to this particular visitor.

Overrides:

defaultAction in class AbstractAtmComboVisitor<Void,AnnotationMirror>

Parameters:

type - the first AnnotatedTypeMirror parameter to the visit method called

inferred - the second AnnotatedTypeMirror parameter to the visit method called

top - subtype specific parameter passed to every visit method

visitTypevar_Typevar

public Void visitTypevar_Typevar(AnnotatedTypeMirror.AnnotatedTypeVariable type,
                                 AnnotatedTypeMirror.AnnotatedTypeVariable inferred,
                                 AnnotationMirror top)

For TypeVariables it is important that we both compare the primary annotation and bounds. Dataflow will default local variables that are also type variables as follows: <T> void method() { @TOP T t; } The type @TOP T is equivalent to a type T[ extends @TOP Object super @TOP Void ] For the following method: <@BOTTOM T extends @TOP Object> void method(T in_t) { T t = in_t; } The type of in_t is the declared type of T and it is below @TOP t, so t should be refined to the declared type of T[ extends @TOP Object super @BOTTOM Void]. To do this, we must apply the the annotations of both bounds to type. This requires a traversal of type.

Specified by:

visitTypevar_Typevar in interface AtmComboVisitor<Void,AnnotationMirror>

Overrides:

visitTypevar_Typevar in class AbstractAtmComboVisitor<Void,AnnotationMirror>

visitTypevar_Wildcard

public Void visitTypevar_Wildcard(AnnotatedTypeMirror.AnnotatedTypeVariable type,
                                  AnnotatedTypeMirror.AnnotatedWildcardType inferred,
                                  AnnotationMirror top)

Specified by:

visitTypevar_Wildcard in interface AtmComboVisitor<Void,AnnotationMirror>

Overrides:

visitTypevar_Wildcard in class AbstractAtmComboVisitor<Void,AnnotationMirror>

visitWildcard_Typevar

public Void visitWildcard_Typevar(AnnotatedTypeMirror.AnnotatedWildcardType type,
                                  AnnotatedTypeMirror.AnnotatedTypeVariable inferred,
                                  AnnotationMirror top)

Specified by:

visitWildcard_Typevar in interface AtmComboVisitor<Void,AnnotationMirror>

Overrides:

visitWildcard_Typevar in class AbstractAtmComboVisitor<Void,AnnotationMirror>

visitWildcard_Wildcard

public Void visitWildcard_Wildcard(AnnotatedTypeMirror.AnnotatedWildcardType type,
                                   AnnotatedTypeMirror.AnnotatedWildcardType inferred,
                                   AnnotationMirror top)

Specified by:

visitWildcard_Wildcard in interface AtmComboVisitor<Void,AnnotationMirror>

Overrides:

visitWildcard_Wildcard in class AbstractAtmComboVisitor<Void,AnnotationMirror>

applyPrimary

protected void applyPrimary(AnnotatedTypeMirror bound,
                            AnnotationMirror anno)