org.checkerframework.qualframework.base

Class TypeAnnotator<Q>

java.lang.Object

org.checkerframework.qualframework.base.TypeAnnotator<Q>

All Implemented Interfaces:

ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

Direct Known Subclasses:

QualifierParameterTypeAnnotator

public class TypeAnnotator<Q>
extends Object
implements ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

DefaultQualifiedTypeFactory component for annotating a ExtendedTypeMirror with qualifiers. The default implementation uses an AnnotationConverter to process any annotations that are present on the type, and uses the top qualifier if there are no annotations.

Field Summary

Fields

Modifier and Type	Field and Description
protected QualifierContext<Q>	qualContext

Constructor Summary

Constructors

Constructor and Description
TypeAnnotator(QualifierContext<Q> qualContext, AnnotationConverter<Q> annotationConverter, Q defaultQual)

Method Summary

Modifier and Type	Method and Description
AnnotationConverter<Q>	getAnnotationConverter()
protected Q	getQualifier(ExtendedTypeMirror type) Default handler to obtain an appropriate qualifier from an ExtendedTypeMirror.
QualifiedTypeMirror<Q>	visit(ExtendedTypeMirror type, Void p)
QualifiedTypeMirror<Q>	visitArray(ExtendedArrayType type, Void p)
QualifiedTypeMirror<Q>	visitDeclared(ExtendedDeclaredType type, Void p)
QualifiedTypeMirror<Q>	visitError(ExtendedErrorType type, Void p)
QualifiedTypeMirror<Q>	visitExecutable(ExtendedExecutableType type, Void p)
QualifiedTypeMirror<Q>	visitIntersection(ExtendedIntersectionType type, Void p)
QualifiedTypeMirror<Q>	visitNoType(ExtendedNoType type, Void p)
QualifiedTypeMirror<Q>	visitNull(ExtendedNullType type, Void p)
QualifiedTypeMirror<Q>	visitParameterDeclaration(ExtendedParameterDeclaration type, Void p)
QualifiedTypeMirror<Q>	visitPrimitive(ExtendedPrimitiveType type, Void p)
QualifiedTypeMirror<Q>	visitTypeDeclaration(ExtendedTypeDeclaration type, Void p)
QualifiedTypeMirror<Q>	visitTypeVariable(ExtendedTypeVariable type, Void p)
QualifiedTypeMirror<Q>	visitUnion(ExtendedUnionType type, Void p)
QualifiedTypeMirror<Q>	visitWildcard(ExtendedWildcardType type, Void p)

Methods inherited from class java.lang.Object

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

Field Detail

qualContext

protected QualifierContext<Q> qualContext

Constructor Detail

TypeAnnotator

public TypeAnnotator(QualifierContext<Q> qualContext,
                     AnnotationConverter<Q> annotationConverter,
                     Q defaultQual)

Method Detail

getAnnotationConverter

public AnnotationConverter<Q> getAnnotationConverter()

visit

public QualifiedTypeMirror<Q> visit(ExtendedTypeMirror type,
                                    Void p)

getQualifier

protected Q getQualifier(ExtendedTypeMirror type)

Default handler to obtain an appropriate qualifier from an ExtendedTypeMirror. The default implementation uses the AnnotationConverter to produce qualifier.

visitArray

public QualifiedTypeMirror<Q> visitArray(ExtendedArrayType type,
                                         Void p)

Specified by:

visitArray in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitDeclared

public QualifiedTypeMirror<Q> visitDeclared(ExtendedDeclaredType type,
                                            Void p)

Specified by:

visitDeclared in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitError

public QualifiedTypeMirror<Q> visitError(ExtendedErrorType type,
                                         Void p)

Specified by:

visitError in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitExecutable

public QualifiedTypeMirror<Q> visitExecutable(ExtendedExecutableType type,
                                              Void p)

Specified by:

visitExecutable in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitIntersection

public QualifiedTypeMirror<Q> visitIntersection(ExtendedIntersectionType type,
                                                Void p)

Specified by:

visitIntersection in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitNoType

public QualifiedTypeMirror<Q> visitNoType(ExtendedNoType type,
                                          Void p)

Specified by:

visitNoType in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitNull

public QualifiedTypeMirror<Q> visitNull(ExtendedNullType type,
                                        Void p)

Specified by:

visitNull in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitPrimitive

public QualifiedTypeMirror<Q> visitPrimitive(ExtendedPrimitiveType type,
                                             Void p)

Specified by:

visitPrimitive in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitTypeVariable

public QualifiedTypeMirror<Q> visitTypeVariable(ExtendedTypeVariable type,
                                                Void p)

Specified by:

visitTypeVariable in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitUnion

public QualifiedTypeMirror<Q> visitUnion(ExtendedUnionType type,
                                         Void p)

Specified by:

visitUnion in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitWildcard

public QualifiedTypeMirror<Q> visitWildcard(ExtendedWildcardType type,
                                            Void p)

Specified by:

visitWildcard in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitParameterDeclaration

public QualifiedTypeMirror<Q> visitParameterDeclaration(ExtendedParameterDeclaration type,
                                                        Void p)

Specified by:

visitParameterDeclaration in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>

visitTypeDeclaration

public QualifiedTypeMirror<Q> visitTypeDeclaration(ExtendedTypeDeclaration type,
                                                   Void p)

Specified by:

visitTypeDeclaration in interface ExtendedTypeVisitor<QualifiedTypeMirror<Q>,Void>