checkers.quals

Enum DefaultLocation

java.lang.Object

java.lang.Enum<DefaultLocation>

checkers.quals.DefaultLocation

All Implemented Interfaces:

Serializable, Comparable<DefaultLocation>

public enum DefaultLocation
extends Enum<DefaultLocation>

Specifies the locations to which a DefaultQualifier annotation applies. The order of enums is important. Defaults are applied in this order. In particular, this means that OTHERWISE and ALL should be last.

See Also:

DefaultQualifier

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Apply default annotations to all unannotated types.
LOCALS Apply default annotations to all unannotated raw types of local types (local variables, casts, and instanceof).
OTHERWISE Apply if nothing more concrete is provided.
PARAMETERS Apply default annotations to all unannotated raw types of parameter types.
RETURNS Apply default annotations to all unannotated raw types of return types.
UPPER_BOUNDS Apply default annotations to unannotated upper bounds: both explicit ones in extends clauses, and implicit upper bounds when no explicit extends or super clause is present.

Method Summary

Modifier and Type	Method and Description
static DefaultLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultLocation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOCALS

public static final DefaultLocation LOCALS

Apply default annotations to all unannotated raw types of local types (local variables, casts, and instanceof).

PARAMETERS

public static final DefaultLocation PARAMETERS

Apply default annotations to all unannotated raw types of parameter types.

RETURNS

public static final DefaultLocation RETURNS

Apply default annotations to all unannotated raw types of return types.

UPPER_BOUNDS

public static final DefaultLocation UPPER_BOUNDS

Apply default annotations to unannotated upper bounds: both explicit ones in extends clauses, and implicit upper bounds when no explicit extends or super clause is present. Especially useful for parametrized classes that provide a lot of static methods with the same generic parameters as the class.

OTHERWISE

public static final DefaultLocation OTHERWISE

Apply if nothing more concrete is provided. TODO: clarify relation to ALL.

ALL

public static final DefaultLocation ALL

Apply default annotations to all unannotated types. Does not allow any of the other constants. Usually you want OTHERWISE.

Method Detail

values

public static DefaultLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DefaultLocation c : DefaultLocation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DefaultLocation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null