org.checkerframework.framework.type.typeannotator

Class ListTypeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.typeannotator.TypeAnnotator

org.checkerframework.framework.type.typeannotator.ListTypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<java.lang.Void,java.lang.Void>

public final class ListTypeAnnotator
extends TypeAnnotator

ListTypeAnnotator is a TypeAnnotator that executes a list of TypeAnnotator for each type visited.

Checkers should not extend ListTypeAnnotator; they should instead pass a custom TypeAnnotator to the constructor.

See Also:

DefaultForTypeAnnotator, PropagationTypeAnnotator

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<TypeAnnotator>	annotators

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
ListTypeAnnotator(java.util.List<TypeAnnotator> annotators)
ListTypeAnnotator(TypeAnnotator... annotators)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Void	scan(AnnotatedTypeMirror type, java.lang.Void aVoid) Scan type by calling type.accept(this, p); this method may be overridden by subclasses.
java.lang.String	toString()

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

visitExecutable

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, wait, wait, wait

Field Detail

annotators

protected final java.util.List<TypeAnnotator> annotators

Constructor Detail

ListTypeAnnotator

public ListTypeAnnotator(TypeAnnotator... annotators)

Parameters:

annotators - the annotators that will be executed for each type scanned by this TypeAnnotator. They are executed in the order passed in.

ListTypeAnnotator

public ListTypeAnnotator(java.util.List<TypeAnnotator> annotators)

Parameters:

annotators - the annotators that will be executed for each type scanned by this TypeAnnotator. They are executed in the order passed in.

Method Detail

scan

protected java.lang.Void scan(AnnotatedTypeMirror type,
                              java.lang.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<java.lang.Void,java.lang.Void>

Parameters:

type - type to scan

aVoid - the parameter to use

Returns:

the result of visiting type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object