org.checkerframework.framework.type.typeannotator

Class IrrelevantTypeAnnotator

java.lang.Object

org.checkerframework.framework.type.visitor.AnnotatedTypeScanner<Void,Void>

org.checkerframework.framework.type.typeannotator.TypeAnnotator

org.checkerframework.framework.type.typeannotator.IrrelevantTypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,Void>

public class IrrelevantTypeAnnotator
extends TypeAnnotator

Adds annotations to types that are not relevant specified by the RelevantJavaTypes on a checker.

Field Summary

Fields inherited from class org.checkerframework.framework.type.typeannotator.TypeAnnotator

typeFactory

Fields inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

visitedNodes

Constructor Summary

Constructors

Constructor and Description
IrrelevantTypeAnnotator(AnnotatedTypeFactory typeFactory, Set<? extends AnnotationMirror> annotations, Class<?>[] relevantClasses) Annotate every type with the annotationMirror except for those whose underlying Java type is one of (or a subtype of) a class in relevantClasses.

Method Summary

Modifier and Type	Method and Description
protected Void	scan(AnnotatedTypeMirror type, Void aVoid) Scan type by calling type.accept(this, p); this method may be overridden by subclasses.
Void	visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType t, Void p) Visits an executable type.

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

reduce, reset, scan, scanAndReduce, scanAndReduce, visit, visit, visitArray, visitDeclared, visitIntersection, visitNoType, visitNull, visitPrimitive, visitTypeVariable, visitUnion, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

IrrelevantTypeAnnotator

public IrrelevantTypeAnnotator(AnnotatedTypeFactory typeFactory,
                               Set<? extends AnnotationMirror> annotations,
                               Class<?>[] relevantClasses)

Annotate every type with the annotationMirror except for those whose underlying Java type is one of (or a subtype of) a class in relevantClasses. (Only adds annotationMirror if no annotation in the hierarchy are already on the type.) If relevantClasses includes Object[].class, then all arrays are considered relevant.

Parameters:

typeFactory - AnnotatedTypeFactory

annotations - annotations to add

relevantClasses - types that should not be annotated with annotationMirror

Method Detail

scan

protected Void scan(AnnotatedTypeMirror type,
                    Void aVoid)

Description copied from class: AnnotatedTypeScanner

Scan type by calling type.accept(this, p); this method may be overridden by subclasses.

Overrides:

scan in class AnnotatedTypeScanner<Void,Void>

Parameters:

type - type to scan

aVoid - the parameter to use

Returns:

the result of visiting type

visitExecutable

public Void visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType t,
                            Void p)

Description copied from interface: AnnotatedTypeVisitor

Visits an executable type.

Specified by:

visitExecutable in interface AnnotatedTypeVisitor<Void,Void>

Overrides:

visitExecutable in class TypeAnnotator

Parameters:

t - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result