org.checkerframework.framework.util.defaults

Class QualifierDefaults

java.lang.Object

org.checkerframework.framework.util.defaults.QualifierDefaults

public class QualifierDefaults
extends Object

Determines the default qualifiers on a type. Default qualifiers are specified via the DefaultQualifier annotation.

See Also:

DefaultQualifier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	QualifierDefaults.BoundType Specifies whether the type variable or wildcard has an explicit upper bound (UPPER), an explicit lower bound (LOWER), or no explicit bounds (UNBOUNDED).
protected class	QualifierDefaults.DefaultApplierElement A default applier element.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutableElement	defaultQualifierListValueElement The value() element/field of a @DefaultQualifier.List annotation.
protected ExecutableElement	defaultQualifierLocationsElement The locations() element/field of a @DefaultQualifier annotation.
protected ExecutableElement	defaultQualifierValueElement The value() element/field of a @DefaultQualifier annotation.
protected Map<Element,QualifierDefaults.BoundType>	elementToBoundType Mapping from an Element to the bound type.
static List<TypeUseLocation>	STANDARD_CLIMB_DEFAULTS_BOTTOM CLIMB locations whose standard default is bottom for a given type system.
static List<TypeUseLocation>	STANDARD_CLIMB_DEFAULTS_TOP CLIMB locations whose standard default is top for a given type system.
static List<TypeUseLocation>	STANDARD_UNCHECKED_DEFAULTS_BOTTOM Standard unchecked default locations that should be bottom.
static List<TypeUseLocation>	STANDARD_UNCHECKED_DEFAULTS_TOP Standard unchecked default locations that should be top.

Constructor Summary

Constructors

Constructor and Description
QualifierDefaults(Elements elements, AnnotatedTypeFactory atypeFactory)

Method Summary

Modifier and Type	Method and Description
void	addCheckedCodeDefault(AnnotationMirror absoluteDefaultAnno, TypeUseLocation location) Sets the default annotations.
void	addCheckedCodeDefaults(AnnotationMirror absoluteDefaultAnno, TypeUseLocation[] locations)
void	addClimbStandardDefaults() Add standard CLIMB defaults that do not conflict with previously added defaults.
void	addElementDefault(Element elem, AnnotationMirror elementDefaultAnno, TypeUseLocation location) Sets the default annotations for a certain Element.
void	addUncheckedCodeDefault(AnnotationMirror uncheckedDefaultAnno, TypeUseLocation location) Sets the default annotation for unchecked elements.
void	addUncheckedCodeDefaults(AnnotationMirror absoluteDefaultAnno, TypeUseLocation[] locations) Sets the default annotation for unchecked elements, with specific locations.
void	addUncheckedStandardDefaults() Add standard unchecked defaults that do not conflict with previously added defaults.
void	annotate(Element elt, AnnotatedTypeMirror type) Applies default annotations to a type given an Element.
void	annotate(Tree tree, AnnotatedTypeMirror type) Applies default annotations to a type given a Tree.
boolean	applyConservativeDefaults(Element annotationScope) Given an element, returns whether the conservative default should be applied for it.
protected QualifierDefaults.DefaultApplierElement	createDefaultApplierElement(AnnotatedTypeFactory atypeFactory, Element annotationScope, AnnotatedTypeMirror type, boolean applyToTypeVar)
QualifierDefaults.BoundType	getWildcardBoundType(AnnotatedTypeMirror.AnnotatedWildcardType annotatedWildcard) Returns the BoundType of annotatedWildcard.
boolean	hasDefaultsForCheckedCode() Check that a default with TypeUseLocation OTHERWISE or ALL is specified.
String	toString()
static List<TypeUseLocation>	validLocationsForUncheckedCodeDefaults() Returns an array of locations that are valid for the unchecked value defaults.

Methods inherited from class java.lang.Object

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

Field Detail

defaultQualifierValueElement

protected final ExecutableElement defaultQualifierValueElement

The value() element/field of a @DefaultQualifier annotation.

defaultQualifierLocationsElement

protected final ExecutableElement defaultQualifierLocationsElement

The locations() element/field of a @DefaultQualifier annotation.

defaultQualifierListValueElement

protected final ExecutableElement defaultQualifierListValueElement

The value() element/field of a @DefaultQualifier.List annotation.

elementToBoundType

protected final Map<Element,QualifierDefaults.BoundType> elementToBoundType

Mapping from an Element to the bound type.

STANDARD_CLIMB_DEFAULTS_TOP

public static final List<TypeUseLocation> STANDARD_CLIMB_DEFAULTS_TOP

CLIMB locations whose standard default is top for a given type system.

STANDARD_CLIMB_DEFAULTS_BOTTOM

public static final List<TypeUseLocation> STANDARD_CLIMB_DEFAULTS_BOTTOM

CLIMB locations whose standard default is bottom for a given type system.

STANDARD_UNCHECKED_DEFAULTS_TOP

public static final List<TypeUseLocation> STANDARD_UNCHECKED_DEFAULTS_TOP

Standard unchecked default locations that should be top.

STANDARD_UNCHECKED_DEFAULTS_BOTTOM

public static final List<TypeUseLocation> STANDARD_UNCHECKED_DEFAULTS_BOTTOM

Standard unchecked default locations that should be bottom.

Constructor Detail

QualifierDefaults

public QualifierDefaults(Elements elements,
                         AnnotatedTypeFactory atypeFactory)

Parameters:

elements - interface to Element data in the current processing environment

atypeFactory - an annotation factory, used to get annotations by name

Method Detail

validLocationsForUncheckedCodeDefaults

public static List<TypeUseLocation> validLocationsForUncheckedCodeDefaults()

Returns an array of locations that are valid for the unchecked value defaults. These are simply by syntax, since an entire file is typechecked, it is not possible for local variables to be unchecked.

toString

public String toString()

Overrides:

toString in class Object

hasDefaultsForCheckedCode

public boolean hasDefaultsForCheckedCode()

Check that a default with TypeUseLocation OTHERWISE or ALL is specified.

Returns:

whether we found a Default with location OTHERWISE or ALL

addUncheckedStandardDefaults

public void addUncheckedStandardDefaults()

Add standard unchecked defaults that do not conflict with previously added defaults.

addClimbStandardDefaults

public void addClimbStandardDefaults()

Add standard CLIMB defaults that do not conflict with previously added defaults.

addCheckedCodeDefault

public void addCheckedCodeDefault(AnnotationMirror absoluteDefaultAnno,
                                  TypeUseLocation location)

Sets the default annotations. A programmer may override this by writing the @DefaultQualifier annotation on an element.

addUncheckedCodeDefault

public void addUncheckedCodeDefault(AnnotationMirror uncheckedDefaultAnno,
                                    TypeUseLocation location)

Sets the default annotation for unchecked elements.

addUncheckedCodeDefaults

public void addUncheckedCodeDefaults(AnnotationMirror absoluteDefaultAnno,
                                     TypeUseLocation[] locations)

Sets the default annotation for unchecked elements, with specific locations.

addCheckedCodeDefaults

public void addCheckedCodeDefaults(AnnotationMirror absoluteDefaultAnno,
                                   TypeUseLocation[] locations)

addElementDefault

public void addElementDefault(Element elem,
                              AnnotationMirror elementDefaultAnno,
                              TypeUseLocation location)

Sets the default annotations for a certain Element.

annotate

public void annotate(Element elt,
                     AnnotatedTypeMirror type)

Applies default annotations to a type given an Element.

Parameters:

elt - the element from which the type was obtained

type - the type to annotate

annotate

public void annotate(Tree tree,
                     AnnotatedTypeMirror type)

Applies default annotations to a type given a Tree.

Parameters:

tree - the tree from which the type was obtained

type - the type to annotate

applyConservativeDefaults

public boolean applyConservativeDefaults(Element annotationScope)

Given an element, returns whether the conservative default should be applied for it. Handles elements from bytecode or source code.

Parameters:

annotationScope - the element that the conservative default might apply to

Returns:

whether the conservative default applies to the given element

createDefaultApplierElement

protected QualifierDefaults.DefaultApplierElement createDefaultApplierElement(AnnotatedTypeFactory atypeFactory,
                                                                              Element annotationScope,
                                                                              AnnotatedTypeMirror type,
                                                                              boolean applyToTypeVar)

getWildcardBoundType

public QualifierDefaults.BoundType getWildcardBoundType(AnnotatedTypeMirror.AnnotatedWildcardType annotatedWildcard)

Returns the BoundType of annotatedWildcard. If it is unbounded, use the type parameter to which its an argument.

Parameters:

annotatedWildcard - the annotated wildcard type

Returns:

the BoundType of annotatedWildcard. If it is unbounded, use the type parameter to which its an argument