checkers.quals.DefaultLocation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checker-quals-jdk5 Show documentation

Annotations ("type qualifiers") from the checker framework, backported so they can be used in pre-JDK8 applications

There is a newer version: 1.7.5

package checkers.quals;

/**
 * Specifies the locations to which a {@link 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 DefaultQualifier
 */
public enum DefaultLocation {

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

    /**
     * Apply default annotations to all unannotated raw types
     * of parameter types.
     */
    PARAMETERS,

    /**
     * Apply default annotations to all unannotated raw types
     * of return types.
     */
    RETURNS,

    /**
     * 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.
     */
    UPPER_BOUNDS,

    /**
     * Apply if nothing more concrete is provided.
     * TODO: clarify relation to ALL.
     */
    OTHERWISE,

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