org.checkerframework.qualframework.poly

Class SimpleQualifierParameterAnnotationConverter<Q>

java.lang.Object

org.checkerframework.qualframework.poly.SimpleQualifierParameterAnnotationConverter<Q>

All Implemented Interfaces:

AnnotationConverter<QualParams<Q>>, QualifierParameterAnnotationConverter<Q>

Direct Known Subclasses:

RegexAnnotationConverter, TaintingAnnotationConverter

public abstract class SimpleQualifierParameterAnnotationConverter<Q>
extends Object
implements QualifierParameterAnnotationConverter<Q>

SimpleQualifierParameterAnnotationConverter abstracts the logic to convert annotations to qualifiers for typical qual-poly types systems that that support @Wild, @Var, and qualifier parameters. getQualifier(javax.lang.model.element.AnnotationMirror) should be implemented to convert an annotation to a type system specific qualifier (e.g. @Regex or @Tainted).

Field Summary

Fields

Modifier and Type	Field and Description
protected Q	BOTTOM
protected Q	DEFAULT_QUAL
protected CombiningOperation<Q>	lowerOp
protected String	MULTI_ANNO_NAME_PREFIX
static String	POLY_NAME The name of the qualifier parameter to use for polymorphic qualifiers.
static String	PRIMARY_TARGET The default "Target" in an annotation is the primary qualifier.
protected static String	SOURCE_VALUE_NAME
static String	TARGET_PARAM_NAME
protected Q	TOP
protected CombiningOperation<Q>	upperOp
protected static String	WILDCARD_NAME

Constructor Summary

Constructors

Constructor and Description
SimpleQualifierParameterAnnotationConverter(AnnotationConverterConfiguration<Q> config) Construct a SimpleQualifierParameterAnnotationConverter.

Method Summary

Modifier and Type	Method and Description
QualParams<Q>	fromAnnotations(Collection<? extends AnnotationMirror> annos) Convert a list of AnnotationMirrors to a QualParams.
Set<String>	getDeclaredParameters(Element elt, Set<AnnotationMirror> declAnnotations, ExtendedTypeMirror type) Get the names of all parameters declared on a class, interface, enum, or method declaration Element.
abstract Q	getQualifier(AnnotationMirror anno) Create a type system qualifier based on an annotation.
protected boolean	hasPolyAnnotationCheck(ExtendedTypeMirror type)
boolean	isAnnotationSupported(AnnotationMirror anno) Checks if an annotation is supported by the current type system.
protected QualParams<Q>	specialCaseHandle(AnnotationMirror anno) Special case handle the AnnotationMirror.

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY_TARGET

public static final String PRIMARY_TARGET

The default "Target" in an annotation is the primary qualifier. We can't use null in the annotation, so we use this special value.

See Also:

Constant Field Values

TARGET_PARAM_NAME

public static final String TARGET_PARAM_NAME

See Also:

Constant Field Values

POLY_NAME

public static final String POLY_NAME

The name of the qualifier parameter to use for polymorphic qualifiers.

See Also:

Constant Field Values

SOURCE_VALUE_NAME

protected static final String SOURCE_VALUE_NAME

See Also:

Constant Field Values

WILDCARD_NAME

protected static final String WILDCARD_NAME

See Also:

Constant Field Values

MULTI_ANNO_NAME_PREFIX

protected final String MULTI_ANNO_NAME_PREFIX

lowerOp

protected final CombiningOperation<Q> lowerOp

upperOp

protected final CombiningOperation<Q> upperOp

BOTTOM

protected final Q BOTTOM

TOP

protected final Q TOP

DEFAULT_QUAL

protected final Q DEFAULT_QUAL

Constructor Detail

SimpleQualifierParameterAnnotationConverter

public SimpleQualifierParameterAnnotationConverter(AnnotationConverterConfiguration<Q> config)

Construct a SimpleQualifierParameterAnnotationConverter.

Method Detail

getQualifier

public abstract Q getQualifier(AnnotationMirror anno)

Create a type system qualifier based on an annotation.

Parameters:

anno - the annotation

Returns:

the resulting qualifier

specialCaseHandle

protected QualParams<Q> specialCaseHandle(AnnotationMirror anno)

Special case handle the AnnotationMirror. Useful for when more control is need when processing an annotation.

fromAnnotations

public QualParams<Q> fromAnnotations(Collection<? extends AnnotationMirror> annos)

Convert a list of AnnotationMirrors to a QualParams. Each AnnotationMirror is converted into a QualParams. The resulting QualParams are merged together to create the result. If no primary qualifier is found, DEFAULT_QUAL will be used.

Specified by:

fromAnnotations in interface AnnotationConverter<QualParams<Q>>

Parameters:

annos - the collection of type annotations to parse

Returns:

the QualParams

isAnnotationSupported

public boolean isAnnotationSupported(AnnotationMirror anno)

Description copied from interface: AnnotationConverter

Checks if an annotation is supported by the current type system. This method should return true if the presence of the provided AnnotationMirror could affect the result of fromAnnotations.

Specified by:

isAnnotationSupported in interface AnnotationConverter<QualParams<Q>>

Parameters:

anno - the annotation to check

Returns:

true if the annotation is supported

getDeclaredParameters

public Set<String> getDeclaredParameters(Element elt,
                                         Set<AnnotationMirror> declAnnotations,
                                         ExtendedTypeMirror type)

Description copied from interface: QualifierParameterAnnotationConverter

Get the names of all parameters declared on a class, interface, enum, or method declaration Element.

Specified by:

getDeclaredParameters in interface QualifierParameterAnnotationConverter<Q>

Parameters:

elt - the element to inspect for parameters

declAnnotations - the declaration annotations on elt

type - the ExtendedTypeMirror for the element, after stub file annotations have been applied

Returns:

the list of declared parameters

hasPolyAnnotationCheck

protected boolean hasPolyAnnotationCheck(ExtendedTypeMirror type)

Returns:

true if type has a polymorphic qualifier