Index

A B C D E F G H I J K L M N O P Q R S T U V W Y Z
All Classes and Interfaces|All Packages

A

A - Annotation Interface in org.checkerframework.checker.units.qual

Ampere.

Acceleration - Annotation Interface in org.checkerframework.checker.units.qual

Units of acceleration.

ALL - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Shorthand for all other LiteralKind constants, other than PRIMITIVE.

ALL - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to all type uses other than uses of type parameters.

allLiteralKinds() - Static method in enum class org.checkerframework.framework.qual.LiteralKind

Returns all LiteralKinds except for ALL and PRIMITIVE (which are shorthands for groups of other LiteralKinds).

AlwaysSafe - Annotation Interface in org.checkerframework.checker.guieffect.qual

Annotation to override the UI effect on a class, and make a field or method safe for non-UI code to use.

Angle - Annotation Interface in org.checkerframework.checker.units.qual

Units of measure for angles.

AnnotatedFor - Annotation Interface in org.checkerframework.framework.qual

Indicates that this class has been annotated for the given type system.

Area - Annotation Interface in org.checkerframework.checker.units.qual

Units of areas.

ARRAY - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.ARRAY types.

ArrayLen - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the length of an array or a string.

ArrayLenRange - Annotation Interface in org.checkerframework.common.value.qual

An expression with this type evaluates to an array or a string whose length is in the given range.

ArrayWithoutPackage - Annotation Interface in org.checkerframework.checker.signature.qual

An identifier or primitive type, followed by any number of array square brackets.

AssertMethod - Annotation Interface in org.checkerframework.dataflow.qual

AssertMethod is a method annotation that indicates that a method throws an exception if the value of a boolean argument is false.

AssertNonNullIfNonNull - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates that if the method returns a non-null value, then the value expressions are also non-null.

atto - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-18.

AwtAlphaCompositingRule - Annotation Interface in org.checkerframework.checker.fenum.qual

Basic alpha compositing rules for combining source and destination colors to achieve blending and transparency effects with graphics and images (see AlphaComposite for more details).

AwtColorSpace - Annotation Interface in org.checkerframework.checker.fenum.qual

Color space tags to identify the specific color space of a Color object or, via a ColorModel object, of an Image, a BufferedImage, or a GraphicsDevice (see ColorSpace for more details).

AwtCursorType - Annotation Interface in org.checkerframework.checker.fenum.qual

AwtCursorType.

AwtFlowLayout - Annotation Interface in org.checkerframework.checker.fenum.qual

Line alignments in a flow layout (see FlowLayout for more details).

B

BinaryName - Annotation Interface in org.checkerframework.checker.signature.qual

Represents a binary name as defined in the Java Language Specification, section 13.1.

BinaryNameOrPrimitiveType - Annotation Interface in org.checkerframework.checker.signature.qual

Represents a primitive type name or a binary name.

BinaryNameWithoutPackage - Annotation Interface in org.checkerframework.checker.signature.qual

Represents a string that is a BinaryName, an InternalForm, and a ClassGetName.

BOOLEAN - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.BOOLEAN_LITERAL trees.

BOOLEAN - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.BOOLEAN types.

BoolVal - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the possible values for a bool type.

Bottom - Annotation Interface in org.checkerframework.common.subtyping.qual

A special annotation intended solely for representing the bottom type in the qualifier hierarchy.

BottomThis - Annotation Interface in org.checkerframework.common.returnsreceiver.qual

The bottom type for the Returns Receiver Checker's type system.

BottomVal - Annotation Interface in org.checkerframework.common.value.qual

The bottom type in the Constant Value type system.

BYTE - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.BYTE types.

C

C - Annotation Interface in org.checkerframework.checker.units.qual

Degree Centigrade (Celsius).

CalledMethods - Annotation Interface in org.checkerframework.checker.builder.qual

A deprecated variant of CalledMethods.

CalledMethods - Annotation Interface in org.checkerframework.checker.calledmethods.qual

If an expression has type @CalledMethods({"m1", "m2"}), then methods m1 and m2 have definitely been called on its value.

CalledMethodsBottom - Annotation Interface in org.checkerframework.checker.calledmethods.qual

The bottom type for the Called Methods type system.

CalledMethodsPredicate - Annotation Interface in org.checkerframework.checker.calledmethods.qual

This annotation represents a predicate on @CalledMethods annotations.

CanonicalName - Annotation Interface in org.checkerframework.checker.signature.qual

Canonical names have the same syntactic form as fully-qualified names.

CanonicalNameAndBinaryName - Annotation Interface in org.checkerframework.checker.signature.qual

This is a string that is a valid canonical name and a valid binary name.

CanonicalNameOrEmpty - Annotation Interface in org.checkerframework.checker.signature.qual

Either a CanonicalName or the empty string.

CanonicalNameOrPrimitiveType - Annotation Interface in org.checkerframework.checker.signature.qual

This is a string that is a valid canonical name and a valid binary name or primitive type.

cd - Annotation Interface in org.checkerframework.checker.units.qual

Candela (unit of luminance).

centi - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-2.

CFComment - Annotation Interface in org.checkerframework.framework.qual

This annotation is for comments related to the Checker Framework.

CHAR - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if the parameter is of a basic types which represent Unicode characters: char, Character, byte, Byte, short, and Short.

CHAR - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.CHAR_LITERAL trees.

CHAR - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.CHAR types.

CHAR_AND_INT - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if the parameter is both a char and an int.

chars - Variable in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

The format specifier characters.

ClassBound - Annotation Interface in org.checkerframework.common.reflection.qual

This represents a Class<T> object whose run-time value is equal to or a subtype of one of the arguments.

ClassGetName - Annotation Interface in org.checkerframework.checker.signature.qual

The type representation used by the Class.getName(), Class.forName(String), and Class.forName(String, boolean, ClassLoader) methods.

ClassGetSimpleName - Annotation Interface in org.checkerframework.checker.signature.qual

The format produced by the Class.getSimpleName() method.

className() - Element in annotation interface org.checkerframework.common.reflection.qual.MethodVal

The binary name of the class that declares this method.

ClassVal - Annotation Interface in org.checkerframework.common.reflection.qual

This represents a Class<T> object where the set of possible values of T is known at compile time.

ClassValBottom - Annotation Interface in org.checkerframework.common.reflection.qual

The bottom type in the ClassVal type system.

CompareToMethod - Annotation Interface in org.checkerframework.checker.interning.qual

Method declaration annotation that indicates a method has a specification like compareTo() or compare().

CompilerMessageKey - Annotation Interface in org.checkerframework.checker.compilermsgs.qual

A string that is definitely a compiler message key.

CompilerMessageKeyBottom - Annotation Interface in org.checkerframework.checker.compilermsgs.qual

The bottom type in the Compiler Message Key type system.

ConditionalPostconditionAnnotation - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation that indicates that an annotation E is a conditional postcondition annotation, i.e., E is a type-specialized version of EnsuresQualifierIf or EnsuresQualifierIf.List.

CONSTRUCTOR_RESULT - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to all unannotated raw types of constructor result types.

ConversionCategory - Enum Class in org.checkerframework.checker.formatter.qual

Elements of this enumeration are used in a Format annotation to indicate the valid types that may be passed as a format parameter.

Covariant - Annotation Interface in org.checkerframework.framework.qual

A marker annotation, written on a class declaration, that signifies that one or more of the class's type parameters can be treated covariantly.

CreatesMustCallFor - Annotation Interface in org.checkerframework.checker.mustcall.qual

Indicates that the method resets the expression's must-call type to its declared type.

CreatesMustCallFor.List - Annotation Interface in org.checkerframework.checker.mustcall.qual

A wrapper annotation that makes the CreatesMustCallFor annotation repeatable.

Current - Annotation Interface in org.checkerframework.checker.units.qual

Electric current.

D

DATE - Enum constant in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Use if the parameter can be of date, time, or number types.

deca - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^1.

deci - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-1.

DECLARED - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.DECLARED types.

DefaultFor - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation applied to the declaration of a type qualifier.

DefaultQualifier - Annotation Interface in org.checkerframework.framework.qual

Applied to a declaration of a package, type, method, variable, etc., specifies that the given annotation should be the default.

DefaultQualifier.List - Annotation Interface in org.checkerframework.framework.qual

A wrapper annotation that makes the DefaultQualifier annotation repeatable.

DefaultQualifierForUse - Annotation Interface in org.checkerframework.framework.qual

Declaration annotation applied to type declarations to specify the qualifier to be added to unannotated uses of the type.

DefaultQualifierInHierarchy - Annotation Interface in org.checkerframework.framework.qual

Indicates that the annotated qualifier is the default qualifier in the qualifier hierarchy: it applies if the programmer writes no explicit qualifier and no other default has been specified for the location.

degrees - Annotation Interface in org.checkerframework.checker.units.qual

Degrees.

Deterministic - Annotation Interface in org.checkerframework.dataflow.qual

A method is called deterministic if it returns the same value (according to ==) every time it is called with the same arguments and in the same environment.

DETERMINISTIC - Enum constant in enum class org.checkerframework.dataflow.qual.Pure.Kind

The method returns exactly the same value when called in the same environment.

DoesNotMatchRegex - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the possible values for a String type.

DotSeparatedIdentifiers - Annotation Interface in org.checkerframework.checker.signature.qual

This is a string that is a valid fully qualified name and a valid binary name.

DotSeparatedIdentifiersOrPrimitiveType - Annotation Interface in org.checkerframework.checker.signature.qual

This is a string that is a valid fully qualified name and a valid binary name or primitive type.

DOUBLE - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.DOUBLE_LITERAL trees.

DOUBLE - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.DOUBLE types.

DoubleVal - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the possible values for a double or float type.

E

EnsuresCalledMethods - Annotation Interface in org.checkerframework.checker.calledmethods.qual

Indicates that the method, if it terminates successfully, always invokes the given methods on the given expressions.

EnsuresCalledMethods.List - Annotation Interface in org.checkerframework.checker.calledmethods.qual

A wrapper annotation that makes the EnsuresCalledMethods annotation repeatable.

EnsuresCalledMethodsIf - Annotation Interface in org.checkerframework.checker.calledmethods.qual

Indicates that the method, if it terminates with the given result, invokes the given methods on the given expressions.

EnsuresCalledMethodsIf.List - Annotation Interface in org.checkerframework.checker.calledmethods.qual

A wrapper annotation that makes the EnsuresCalledMethodsIf annotation repeatable.

EnsuresCalledMethodsOnException - Annotation Interface in org.checkerframework.checker.calledmethods.qual

Indicates that the method, if it terminates by throwing an Exception, always invokes the given methods on the given expressions.

EnsuresCalledMethodsOnException.List - Annotation Interface in org.checkerframework.checker.calledmethods.qual

A wrapper annotation that makes the EnsuresCalledMethodsOnException annotation repeatable.

EnsuresCalledMethodsVarArgs - Annotation Interface in org.checkerframework.checker.calledmethods.qual

Indicates that the method, if it terminates successfully, always invokes the given methods on all of the arguments passed in the varargs position.

EnsuresInitializedFields - Annotation Interface in org.checkerframework.common.initializedfields.qual

A method postcondition annotation indicates which fields the method definitely initializes.

EnsuresInitializedFields.List - Annotation Interface in org.checkerframework.common.initializedfields.qual

A wrapper annotation that makes the EnsuresInitializedFields annotation repeatable.

EnsuresKeyFor - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates that the value expressions evaluate to a value that is a key in all the given maps, if the method terminates successfully.

EnsuresKeyFor.List - Annotation Interface in org.checkerframework.checker.nullness.qual

A wrapper annotation that makes the EnsuresKeyFor annotation repeatable.

EnsuresKeyForIf - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates that the given expressions evaluate to a value that is a key in all the given maps, if the method returns the given result (either true or false).

EnsuresKeyForIf.List - Annotation Interface in org.checkerframework.checker.nullness.qual

A wrapper annotation that makes the EnsuresKeyForIf annotation repeatable.

EnsuresLockHeld - Annotation Interface in org.checkerframework.checker.lock.qual

Indicates that the given expressions are held if the method terminates successfully.

EnsuresLockHeld.List - Annotation Interface in org.checkerframework.checker.lock.qual

A wrapper annotation that makes the EnsuresLockHeld annotation repeatable.

EnsuresLockHeldIf - Annotation Interface in org.checkerframework.checker.lock.qual

Indicates that the given expressions are held if the method terminates successfully and returns the given result (either true or false).

EnsuresLockHeldIf.List - Annotation Interface in org.checkerframework.checker.lock.qual

A wrapper annotation that makes the EnsuresLockHeldIf annotation repeatable.

EnsuresLTLengthOf - Annotation Interface in org.checkerframework.checker.index.qual

Indicates that the value expressions evaluate to an integer whose value is less than the lengths of all the given sequences, if the method terminates successfully.

EnsuresLTLengthOf.List - Annotation Interface in org.checkerframework.checker.index.qual

A wrapper annotation that makes the EnsuresLTLengthOf annotation repeatable.

EnsuresLTLengthOfIf - Annotation Interface in org.checkerframework.checker.index.qual

Indicates that the given expressions evaluate to an integer whose value is less than the lengths of all the given sequences, if the method returns the given result (either true or false).

EnsuresLTLengthOfIf.List - Annotation Interface in org.checkerframework.checker.index.qual

A wrapper annotation that makes the EnsuresLTLengthOfIf annotation repeatable.

EnsuresMinLenIf - Annotation Interface in org.checkerframework.common.value.qual

Indicates that the value of the given expression is a sequence containing at least the given number of elements, if the method returns the given result (either true or false).

EnsuresMinLenIf.List - Annotation Interface in org.checkerframework.common.value.qual

A wrapper annotation that makes the EnsuresMinLenIf annotation repeatable.

EnsuresNonNull - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates that the value expressions are non-null just after a method call, if the method terminates successfully.

EnsuresNonNull.List - Annotation Interface in org.checkerframework.checker.nullness.qual

A wrapper annotation that makes the EnsuresNonNull annotation repeatable.

EnsuresNonNullIf - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates that the given expressions are non-null, if the method returns the given result (either true or false).

EnsuresNonNullIf.List - Annotation Interface in org.checkerframework.checker.nullness.qual

* A wrapper annotation that makes the EnsuresNonNullIf annotation repeatable.

EnsuresPresent - Annotation Interface in org.checkerframework.checker.optional.qual

Indicates that the expression evaluates to a non-empty Optional, if the method terminates successfully.

EnsuresPresentIf - Annotation Interface in org.checkerframework.checker.optional.qual

Indicates that the given expressions of type Optional<T> are present, if the method returns the given result (either true or false).

EnsuresPresentIf.List - Annotation Interface in org.checkerframework.checker.optional.qual

A wrapper annotation that makes the EnsuresPresentIf annotation repeatable.

EnsuresQualifier - Annotation Interface in org.checkerframework.framework.qual

A postcondition annotation to indicate that a method ensures that certain expressions have a certain type qualifier once the method has successfully terminated.

EnsuresQualifier.List - Annotation Interface in org.checkerframework.framework.qual

A wrapper annotation that makes the EnsuresQualifier annotation repeatable.

EnsuresQualifierIf - Annotation Interface in org.checkerframework.framework.qual

A conditional postcondition annotation to indicate that a method ensures that certain expressions have a certain qualifier once the method has terminated, and if the result is as indicated by result.

EnsuresQualifierIf.List - Annotation Interface in org.checkerframework.framework.qual

A wrapper annotation that makes the EnsuresQualifierIf annotation repeatable.

EnumVal - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the possible values for an enum type.

EqualsMethod - Annotation Interface in org.checkerframework.checker.interning.qual

Method declaration annotation that indicates a method has a specification like equals().

ERROR - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.ERROR types.

exa - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^18.

EXCEPTION_PARAMETER - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to all unannotated raw types of exception parameters.

EXECUTABLE - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.EXECUTABLE types.

EXPLICIT_LOWER_BOUND - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to unannotated, but explicit lower bounds: <? super Object>

EXPLICIT_UPPER_BOUND - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to unannotated, but explicit upper bounds: <T extends Object>.

expression() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsIf

Returns Java expressions that have had the given methods called on them after the method returns EnsuresCalledMethodsIf.result().

expression() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOfIf

Java expression(s) that are less than the length of the given sequences after the method returns the given result.

expression() - Element in annotation interface org.checkerframework.checker.lock.qual.EnsuresLockHeldIf

Returns Java expressions whose values are locks that are held after the method returns the given result.

expression() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresKeyForIf

Java expressions that are keys in the given maps after the method returns the given result.

expression() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresNonNullIf

Returns Java expression(s) that are non-null after the method returns the given result.

expression() - Element in annotation interface org.checkerframework.checker.optional.qual.EnsuresPresentIf

Returns the Java expressions of type Optional<T> that are present after the method returns the given result.

expression() - Element in annotation interface org.checkerframework.common.value.qual.EnsuresMinLenIf

Returns Java expression(s) that are a sequence with the given minimum length after the method returns EnsuresMinLenIf.result().

expression() - Element in annotation interface org.checkerframework.framework.qual.EnsuresQualifier

Returns the Java expressions for which the qualifier holds after successful method termination.

expression() - Element in annotation interface org.checkerframework.framework.qual.EnsuresQualifierIf

Returns the Java expressions for which the qualifier holds if the method terminates with return value EnsuresQualifierIf.result().

expression() - Element in annotation interface org.checkerframework.framework.qual.RequiresQualifier

Returns the Java expressions for which the annotation need to be present.

F

FBCBottom - Annotation Interface in org.checkerframework.checker.initialization.qual

The bottom type in the initialization type system.

femto - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-15.

Fenum - Annotation Interface in org.checkerframework.checker.fenum.qual

A generic fake enumeration qualifier that is parameterized by a name.

FenumBottom - Annotation Interface in org.checkerframework.checker.fenum.qual

The bottom type in the Fenum type system.

FenumTop - Annotation Interface in org.checkerframework.checker.fenum.qual

The top of the fake enumeration type hierarchy.

FenumUnqualified - Annotation Interface in org.checkerframework.checker.fenum.qual

An unqualified type.

field() - Element in annotation interface org.checkerframework.common.value.qual.MinLenFieldInvariant

The field that has an array length qualifier in the class on which the field invariant is written.

field() - Element in annotation interface org.checkerframework.framework.qual.FieldInvariant

The field that has a more precise type, in the class on which the FieldInvariant annotation is written.

FIELD - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to all unannotated raw types of fields.

FieldDescriptor - Annotation Interface in org.checkerframework.checker.signature.qual

Represents a field descriptor (JVM type format) as defined in the Java Virtual Machine Specification, section 4.3.2.

FieldDescriptorForPrimitive - Annotation Interface in org.checkerframework.checker.signature.qual

Represents a field descriptor (JVM type format) for a primitive as defined in the Java Virtual Machine Specification, section 4.3.2.

FieldDescriptorWithoutPackage - Annotation Interface in org.checkerframework.checker.signature.qual

Represents a field descriptor for a primitive or for an array whose base type is primitive or in the unnamed package.

FieldInvariant - Annotation Interface in org.checkerframework.framework.qual

Specifies that a field's type, in the class on which this annotation is written, is a subtype of its declared type.

fields() - Element in annotation interface org.checkerframework.common.initializedfields.qual.EnsuresInitializedFields

Fields that this method initializes.

FindDistinct - Annotation Interface in org.checkerframework.checker.interning.qual

This formal parameter annotation indicates that the method searches for the given value, using reference equality (==).

FLOAT - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if the parameter is a floating-point type: float, Float, double, Double, and BigDecimal.

FLOAT - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.FLOAT_LITERAL trees.

FLOAT - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.FLOAT types.

Force - Annotation Interface in org.checkerframework.checker.units.qual

Units of force.

Format - Annotation Interface in org.checkerframework.checker.formatter.qual

This annotation, attached to a String type, indicates that the String may be passed to Formatter.format and similar methods.

FormatBottom - Annotation Interface in org.checkerframework.checker.formatter.qual

The bottom type in the Format String type system.

FormatMethod - Annotation Interface in org.checkerframework.checker.formatter.qual

If this annotation is attached to a Formatter.format-like method, then the first parameter of type String is treated as a format string for the following arguments.

ForName - Annotation Interface in org.checkerframework.common.reflection.qual

Annotation for methods like Class.forName.

FqBinaryName - Annotation Interface in org.checkerframework.checker.signature.qual

An extension of binary name format to represent primitives and arrays.

from() - Element in annotation interface org.checkerframework.checker.index.qual.HasSubsequence

The index into this where the subsequence starts.

from() - Element in annotation interface org.checkerframework.common.value.qual.ArrayLenRange

Smallest value in the range, inclusive.

from() - Element in annotation interface org.checkerframework.common.value.qual.IntRange

Largest value in the range, inclusive.

FromByteCode - Annotation Interface in org.checkerframework.framework.qual

If a method is annotated with this declaration annotation, then its signature is not written in a stub file and the method is not declared in source.

fromConversionChar(char) - Static method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Converts a conversion character to a category.

FromStubFile - Annotation Interface in org.checkerframework.framework.qual

If a method is annotated with this declaration annotation, then its signature was read from a stub file.

FullyQualifiedName - Annotation Interface in org.checkerframework.checker.signature.qual

A sequence of dot-separated identifiers, followed by any number of array square brackets.

G

g - Annotation Interface in org.checkerframework.checker.units.qual

Gram.

GENERAL - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if the parameter can be of any type.

GENERAL - Enum constant in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Use if the parameter can be of any type.

GetClass - Annotation Interface in org.checkerframework.common.reflection.qual

Annotation for methods like Object.getClassName.

GetConstructor - Annotation Interface in org.checkerframework.common.reflection.qual

Annotation for methods like Class.getConstructor, whose signature is:
@MethodVal(classname=c, methodname="<init>", params=p) Constructor<T> method(Class<c> this, Object... params)

GetMethod - Annotation Interface in org.checkerframework.common.reflection.qual

Annotation for methods like Class.getMethod and Class.getDeclaredMethod, whose signature is:
{@link MethodVal}(classname=c, methodname=m, params=p) Method getMyMethod(Class<c> this, String m, Object... params)

giga - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^9.

GTENegativeOne - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to an integer greater than or equal to -1.

GuardedBy - Annotation Interface in org.checkerframework.checker.lock.qual

Indicates that a thread may dereference the value referred to by the annotated variable only if the thread holds all the given lock expressions.

GuardedByBottom - Annotation Interface in org.checkerframework.checker.lock.qual

The bottom type in the GuardedBy type system.

GuardedByUnknown - Annotation Interface in org.checkerframework.checker.lock.qual

It is unknown what locks guard the value referred to by the annotated variable.

GuardSatisfied - Annotation Interface in org.checkerframework.checker.lock.qual

If a variable x has type @GuardSatisfied, then all lock expressions for x's value are held.

H

h - Annotation Interface in org.checkerframework.checker.units.qual

Hour.

HasQualifierParameter - Annotation Interface in org.checkerframework.framework.qual

This is a declaration annotation that applies to type declarations and packages.

HasSubsequence - Annotation Interface in org.checkerframework.checker.index.qual

The annotated sequence contains a subsequence that is equal to the value of some other expression.

hecto - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^2.

Holding - Annotation Interface in org.checkerframework.checker.lock.qual

Indicates a method precondition: the specified expressions must be held when the annotated method is invoked.

I

I18nChecksFormat - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

This annotation is used internally to annotate I18nFormatUtil.hasFormat() and similar methods.

I18nConversionCategory - Enum Class in org.checkerframework.checker.i18nformatter.qual

Elements of this enumeration are used in a I18nFormat annotation to indicate the valid types that may be passed as a format parameter.

I18nFormat - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

This annotation, attached to a String type, indicates that the String may be passed to MessageFormat.format.

I18nFormatBottom - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

The bottom type in the Internationalization Format String type system.

I18nFormatFor - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

This annotation indicates that when a string of the annotated type is passed as the first argument to MessageFormat.format(String, Object...), then the expression that is an argument to the annotation can be passed as the remaining arguments, in varargs style.

I18nInvalidFormat - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

This annotation, attached to a String type, indicates that if the String is passed to MessageFormat.format(String, Object...), an exception will result.

I18nMakeFormat - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

This annotation is used internally to annotate ResourceBundle.getString(java.lang.String) indicating the checker to check if the given key exist in the translation file and annotate the result string with the correct format annotation according to the corresponding key's value.

I18nUnknownFormat - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

The top qualifier.

I18nValidFormat - Annotation Interface in org.checkerframework.checker.i18nformatter.qual

This annotation is used internally to annotate I18nFormatUtil.isFormat().

Identifier - Annotation Interface in org.checkerframework.checker.signature.qual

An identifier.

IdentifierOrPrimitiveType - Annotation Interface in org.checkerframework.checker.signature.qual

An identifier or a primitive type.

IgnoreInWholeProgramInference - Annotation Interface in org.checkerframework.framework.qual

This annotation can be used two ways:

IMPLICIT_LOWER_BOUND - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to unannotated, but implicit lower bounds: <T> <?>.

IMPLICIT_UPPER_BOUND - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to unannotated type variables: <T>.

Impure - Annotation Interface in org.checkerframework.dataflow.qual

Impure is a method annotation that means the method might have side effects and/or might be nondeterministic.

IndexFor - Annotation Interface in org.checkerframework.checker.index.qual

An integer that can be used to index any of the given sequences.

IndexOrHigh - Annotation Interface in org.checkerframework.checker.index.qual

An integer that, for each of the given sequences, is either a valid index or is equal to the sequence's length.

IndexOrLow - Annotation Interface in org.checkerframework.checker.index.qual

An integer that is either -1 or is a valid index for each of the given sequences.

InheritableMustCall - Annotation Interface in org.checkerframework.checker.mustcall.qual

This annotation is an alias for MustCall that applies to the type on which it is written and all of its subtypes.

InheritedAnnotation - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation that specifies if a declaration annotation should be inherited.

Initialized - Annotation Interface in org.checkerframework.checker.initialization.qual

This type qualifier belongs to the freedom-before-commitment initialization tracking type-system.

InitializedFields - Annotation Interface in org.checkerframework.common.initializedfields.qual

Indicates which fields have definitely been initialized.

InitializedFieldsBottom - Annotation Interface in org.checkerframework.common.initializedfields.qual

The bottom type qualifier for the Initialized Fields type system.

INT - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if the parameter is an integral type: byte, Byte, short, Short, int and Integer, long, Long, and BigInteger.

INT - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.INT_LITERAL trees.

INT - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.INT types.

INT_AND_TIME - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if the parameter is both an int and a time.

InternalForm - Annotation Interface in org.checkerframework.checker.signature.qual

The syntax for binary names that appears in a class file, as defined in the JVM Specification, section 4.2.

Interned - Annotation Interface in org.checkerframework.checker.interning.qual

Indicates that a variable has been interned, i.e., that the variable refers to the canonical representation of an object.

InternedDistinct - Annotation Interface in org.checkerframework.checker.interning.qual

Indicates that no other value is equals() to the given value.

InternMethod - Annotation Interface in org.checkerframework.checker.interning.qual

Method declaration annotation used to indicate that this method may be invoked on an uninterned object and that it returns an interned object.

intersect(ConversionCategory, ConversionCategory) - Static method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Returns the intersection of two categories.

intersect(I18nConversionCategory, I18nConversionCategory) - Static method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Returns the intersection of the two given I18nConversionCategories.

INTERSECTION - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.INTERSECTION types.

IntRange - Annotation Interface in org.checkerframework.common.value.qual

An expression with this type evaluates to an integral value (byte, short, char, int, or long) in the given range.

IntRangeFromGTENegativeOne - Annotation Interface in org.checkerframework.common.value.qual

An expression with this type is exactly the same as an IntRange annotation whose from field is -1 and whose to field is Integer.MAX_VALUE.

IntRangeFromNonNegative - Annotation Interface in org.checkerframework.common.value.qual

An expression with this type is exactly the same as an IntRange annotation whose from field is 0 and whose to field is Integer.MAX_VALUE.

IntRangeFromPositive - Annotation Interface in org.checkerframework.common.value.qual

An expression with this type is exactly the same as an IntRange annotation whose from field is 1 and whose to field is Integer.MAX_VALUE.

IntVal - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the possible values for a byte, short, char, int, or long type.

InvalidFormat - Annotation Interface in org.checkerframework.checker.formatter.qual

This annotation, attached to a String type, indicates that the string is not a legal format string.

InvisibleQualifier - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation indicating that an annotation is a type qualifier that should not be visible in output.

Invoke - Annotation Interface in org.checkerframework.common.reflection.qual

Annotation for methods like Method.invoke, whose signature is:
Object method({@link MethodVal}(classname=c, methodname=m, params=p) Method this, Object obj, Object... args)

isAssertFalse() - Element in annotation interface org.checkerframework.dataflow.qual.AssertMethod

Returns whether this method asserts that the boolean expression is false.

isAssignableFrom(Class<?>) - Method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Returns true if argType can be an argument used by this format specifier.

isAssignableFrom(Class<?>) - Method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Returns true if argType can be an argument used by this format specifier.

isSubsetOf(ConversionCategory, ConversionCategory) - Static method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

isSubsetOf(I18nConversionCategory, I18nConversionCategory) - Static method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Return true if a is a subset of b.

J

JavaExpression - Annotation Interface in org.checkerframework.framework.qual

An annotation to use on an element of a dependent type qualifier to specify which elements of the annotation should be interpreted as Java expressions.

K

K - Annotation Interface in org.checkerframework.checker.units.qual

Kelvin (unit of temperature).

KeyFor - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates that the value assigned to the annotated variable is a key for at least the given map(s).

KeyForBottom - Annotation Interface in org.checkerframework.checker.nullness.qual

The bottom type in the Map Key type system.

kg - Annotation Interface in org.checkerframework.checker.units.qual

Kilogram.

kilo - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^3.

km - Annotation Interface in org.checkerframework.checker.units.qual

Kilometer.

km2 - Annotation Interface in org.checkerframework.checker.units.qual

Square kilometer.

km3 - Annotation Interface in org.checkerframework.checker.units.qual

Cubic kilometer.

kmPERh - Annotation Interface in org.checkerframework.checker.units.qual

Kilometer per hour.

kN - Annotation Interface in org.checkerframework.checker.units.qual

Kilonewton.

L

LeakedToResult - Annotation Interface in org.checkerframework.common.aliasing.qual

This annotation is used on a formal parameter to indicate that the parameter may be returned, but it is not otherwise leaked.

Length - Annotation Interface in org.checkerframework.checker.units.qual

Units of length.

LengthOf - Annotation Interface in org.checkerframework.checker.index.qual

An integer that, for each of the given sequences, is equal to the sequence's length.

LessThan - Annotation Interface in org.checkerframework.checker.index.qual

An annotation indicating the relationship between values with a byte, short, char, int, or long type.

LessThanBottom - Annotation Interface in org.checkerframework.checker.index.qual

The bottom type in the LessThan type system.

LessThanUnknown - Annotation Interface in org.checkerframework.checker.index.qual

The top qualifier for the LessThan type hierarchy.

LiteralKind - Enum Class in org.checkerframework.framework.qual

Specifies kinds of literal trees.

LOCAL_VARIABLE - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

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

LocalizableKey - Annotation Interface in org.checkerframework.checker.i18n.qual

Indicates that the String is a key into a property file or resource bundle containing Localized Strings.

LocalizableKeyBottom - Annotation Interface in org.checkerframework.checker.i18n.qual

The bottom type in the Internationalization type system.

Localized - Annotation Interface in org.checkerframework.checker.i18n.qual

Indicates that the String type has been localized and formatted for the target output locale.

locations() - Element in annotation interface org.checkerframework.framework.qual.DefaultQualifier

Returns the locations to which the annotation should be applied.

LockHeld - Annotation Interface in org.checkerframework.checker.lock.qual

Indicates that an expression is used as a lock and the lock is known to be held on the current thread.

LockingFree - Annotation Interface in org.checkerframework.checker.lock.qual

The method neither acquires nor releases locks, nor do any of the methods that it calls.

LockPossiblyHeld - Annotation Interface in org.checkerframework.checker.lock.qual

Indicates that an expression is not known to be LockHeld.

LONG - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.LONG_LITERAL trees.

LONG - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.LONG types.

LOWER_BOUND - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to unannotated lower bounds for type variables and wildcards both explicit ones in extends clauses, and implicit upper bounds when no explicit extends or super clause is present.

LowerBoundBottom - Annotation Interface in org.checkerframework.checker.index.qual

The bottom type of the lower bound type system.

LowerBoundUnknown - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to value that might be -2 or lower.

LTEqLengthOf - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to an integer whose value is less than or equal to the lengths of all the given sequences.

LTLengthOf - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to an integer whose value is less than the lengths of all the given sequences.

LTOMLengthOf - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to an integer whose value is at least 2 less than the lengths of all the given sequences.

Luminance - Annotation Interface in org.checkerframework.checker.units.qual

Units of luminance.

M

m - Annotation Interface in org.checkerframework.checker.units.qual

Meter.

m2 - Annotation Interface in org.checkerframework.checker.units.qual

Square meter.

m3 - Annotation Interface in org.checkerframework.checker.units.qual

Cubic meter.

map() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresKeyFor

Returns Java expressions whose values are maps, each of which contains each expression value as a key (after successful method termination).

map() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresKeyForIf

Returns Java expressions whose values are maps, each of which contains each expression value as a key (after the method returns the given result).

Mass - Annotation Interface in org.checkerframework.checker.units.qual

Units of mass.

MatchesRegex - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the possible values for a String type.

MaybeAliased - Annotation Interface in org.checkerframework.common.aliasing.qual

An expression with this type might have an alias.

MaybeLeaked - Annotation Interface in org.checkerframework.common.aliasing.qual

Temporary type qualifier:

MaybePresent - Annotation Interface in org.checkerframework.checker.optional.qual

The Optional container may or may not contain a value.

MayReleaseLocks - Annotation Interface in org.checkerframework.checker.lock.qual

The method, or one of the methods it calls, might release locks that were held prior to the method being called.

mega - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^6.

MethodDescriptor - Annotation Interface in org.checkerframework.checker.signature.qual

Represents a method descriptor (JVM representation of method signature) as defined in the Java Virtual Machine Specification, section 4.3.3.

methodName() - Element in annotation interface org.checkerframework.common.reflection.qual.MethodVal

The name of the method that this Method object represents.

methods() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethods

The methods guaranteed to be invoked on the expressions.

methods() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsIf

The methods guaranteed to be invoked on the expressions if the result of the method is EnsuresCalledMethodsIf.result().

methods() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsOnException

The methods guaranteed to be invoked on the expressions if the result of the method throws an exception.

methods() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.RequiresCalledMethods

The methods guaranteed to be invoked on the expressions.

MethodVal - Annotation Interface in org.checkerframework.common.reflection.qual

This represents a set of Method or Constructor values.

MethodValBottom - Annotation Interface in org.checkerframework.common.reflection.qual

The bottom type in the MethodVal type system.

micro - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-6.

milli - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-3.

min - Annotation Interface in org.checkerframework.checker.units.qual

Minute.

minLen() - Element in annotation interface org.checkerframework.common.value.qual.MinLenFieldInvariant

Min length of the array.

MinLen - Annotation Interface in org.checkerframework.common.value.qual

The value of the annotated expression is a sequence containing at least the given number of elements.

MinLenFieldInvariant - Annotation Interface in org.checkerframework.common.value.qual

A specialization of FieldInvariant for specifying the minimum length of an array.

MixedUnits - Annotation Interface in org.checkerframework.checker.units.qual

MixedUnits is the result of multiplying or dividing units, where no more specific unit is known from a UnitsRelations implementation.

mm - Annotation Interface in org.checkerframework.checker.units.qual

Millimeter.

mm2 - Annotation Interface in org.checkerframework.checker.units.qual

Square millimeter.

mm3 - Annotation Interface in org.checkerframework.checker.units.qual

Cubic millimeter.

mol - Annotation Interface in org.checkerframework.checker.units.qual

Mole (unit of Substance).

MonotonicNonNull - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates that once the field (or variable) becomes non-null, it never becomes null again.

MonotonicQualifier - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation that indicates that a qualifier indicates that an expression goes monotonically from a type qualifier T to another qualifier S.

mPERs - Annotation Interface in org.checkerframework.checker.units.qual

Meter per second.

mPERs2 - Annotation Interface in org.checkerframework.checker.units.qual

Meter per second squared.

MustCall - Annotation Interface in org.checkerframework.checker.mustcall.qual

An expression of type @MustCall({"m1", "m2"}) may be obligated to call m1() and/or m2() before it is deallocated, but it is not obligated to call any other methods.

MustCallAlias - Annotation Interface in org.checkerframework.checker.mustcall.qual

This polymorphic annotation represents an either-or must-call obligation.

MustCallUnknown - Annotation Interface in org.checkerframework.checker.mustcall.qual

The top qualifier in the Must Call type hierarchy.

N

N - Annotation Interface in org.checkerframework.checker.units.qual

Newton.

names() - Element in annotation interface org.checkerframework.framework.qual.DefaultFor

Returns regular expressions matching names of variables, to whose types the annotation should be applied as a default.

namesExceptions() - Element in annotation interface org.checkerframework.framework.qual.DefaultFor

Returns exceptions to regular expression rules.

nano - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-9.

NegativeIndexFor - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression is between -1 and -a.length - 1, inclusive, for each sequence a listed in the annotation.

NewInstance - Annotation Interface in org.checkerframework.common.reflection.qual

Annotation for methods like Constructor.newInstance, whose signature is:
T method(MethodVal(classname=c, methodname="<init>", params=p) Constructor this, Object... args)

NewObject - Annotation Interface in org.checkerframework.checker.lock.qual

A type that represents a newly-constructed object.

NoDefaultQualifierForUse - Annotation Interface in org.checkerframework.framework.qual

Declaration annotation applied to type declarations to specify that the annotation on the type declaration should not be applied to unannotated uses of the type.

NONE - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.NONE types.

NonLeaked - Annotation Interface in org.checkerframework.common.aliasing.qual

This annotation is used on a formal parameter to indicate that the parameter is not leaked (stored in a location that could be accessed later) nor returned by the method body.

NonNegative - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to an integer greater than or equal to 0.

NonNull - Annotation Interface in org.checkerframework.checker.nullness.qual

If an expression's type is qualified by @NonNull, then the expression never evaluates to null.

NoQualifierParameter - Annotation Interface in org.checkerframework.framework.qual

This is a declaration annotation that applies to type declarations.

NotCalledMethods - Annotation Interface in org.checkerframework.checker.builder.qual

An annotation speculatively used by Lombok's lombok.config checkerframework = true option.

NotOnlyInitialized - Annotation Interface in org.checkerframework.checker.initialization.qual

A declaration annotation for fields that indicates that a client might observe the field storing values that are Initialized, UnderInitialization, or UnknownInitialization, regardless of the initialization type annotation on the field's type.

NotOwning - Annotation Interface in org.checkerframework.checker.mustcall.qual

Annotation indicating that ownership should not be transferred to the annotated parameter, field, or method's call sites, for the purposes of Must Call checking.

NULL - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if no object of any type can be passed as parameter.

NULL - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.NULL_LITERAL trees.

NULL - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.NULL types.

Nullable - Annotation Interface in org.checkerframework.checker.nullness.qual

Nullable is a type annotation that makes no commitments about whether the value is null.

NUMBER - Enum constant in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Use if the parameter can be of number or choice types.

O

offset() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOf

This expression plus each of the value expressions is less than the length of the sequence on successful method termination.

offset() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOfIf

This expression plus each of the expressions is less than the length of the sequence after the method returns the given result.

offset() - Element in annotation interface org.checkerframework.checker.index.qual.LTLengthOf

This expression plus the annotated expression is less than the length of the sequence.

offset() - Element in annotation interface org.checkerframework.checker.index.qual.SubstringIndexFor

This expression plus the annotated expression is less than the length of the corresponding sequence in the value array.

one - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^0, or 1.

OptionalBottom - Annotation Interface in org.checkerframework.checker.optional.qual

The bottom type qualifier for the Optional Checker.

OptionalCreator - Annotation Interface in org.checkerframework.checker.optional.qual

An method annotation for methods that create an Optional

OptionalEliminator - Annotation Interface in org.checkerframework.checker.optional.qual

Methods whose receiver is an Optional and return a non-optional.

OptionalPropagator - Annotation Interface in org.checkerframework.checker.optional.qual

Methods whose receiver is an Optional and return an Optional.

org.checkerframework.checker.builder.qual - package org.checkerframework.checker.builder.qual

org.checkerframework.checker.calledmethods.qual - package org.checkerframework.checker.calledmethods.qual

org.checkerframework.checker.compilermsgs.qual - package org.checkerframework.checker.compilermsgs.qual

Qualifiers for the Compiler Message Key Checker.

org.checkerframework.checker.fenum.qual - package org.checkerframework.checker.fenum.qual

org.checkerframework.checker.formatter.qual - package org.checkerframework.checker.formatter.qual

org.checkerframework.checker.guieffect.qual - package org.checkerframework.checker.guieffect.qual

org.checkerframework.checker.i18n.qual - package org.checkerframework.checker.i18n.qual

org.checkerframework.checker.i18nformatter.qual - package org.checkerframework.checker.i18nformatter.qual

org.checkerframework.checker.index.qual - package org.checkerframework.checker.index.qual

org.checkerframework.checker.initialization.qual - package org.checkerframework.checker.initialization.qual

org.checkerframework.checker.interning.qual - package org.checkerframework.checker.interning.qual

org.checkerframework.checker.lock.qual - package org.checkerframework.checker.lock.qual

org.checkerframework.checker.mustcall.qual - package org.checkerframework.checker.mustcall.qual

org.checkerframework.checker.nullness.qual - package org.checkerframework.checker.nullness.qual

org.checkerframework.checker.optional.qual - package org.checkerframework.checker.optional.qual

org.checkerframework.checker.propkey.qual - package org.checkerframework.checker.propkey.qual

org.checkerframework.checker.regex.qual - package org.checkerframework.checker.regex.qual

org.checkerframework.checker.signature.qual - package org.checkerframework.checker.signature.qual

org.checkerframework.checker.signedness.qual - package org.checkerframework.checker.signedness.qual

org.checkerframework.checker.tainting.qual - package org.checkerframework.checker.tainting.qual

org.checkerframework.checker.units.qual - package org.checkerframework.checker.units.qual

org.checkerframework.common.aliasing.qual - package org.checkerframework.common.aliasing.qual

org.checkerframework.common.initializedfields.qual - package org.checkerframework.common.initializedfields.qual

org.checkerframework.common.reflection.qual - package org.checkerframework.common.reflection.qual

org.checkerframework.common.returnsreceiver.qual - package org.checkerframework.common.returnsreceiver.qual

org.checkerframework.common.subtyping.qual - package org.checkerframework.common.subtyping.qual

org.checkerframework.common.util.count.report.qual - package org.checkerframework.common.util.count.report.qual

org.checkerframework.common.value.qual - package org.checkerframework.common.value.qual

org.checkerframework.dataflow.qual - package org.checkerframework.dataflow.qual

org.checkerframework.framework.qual - package org.checkerframework.framework.qual

Contains the basic annotations to be used by all type systems and meta-annotations to qualify annotations (qualifiers).

OTHER - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.OTHER types.

OTHERWISE - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply if nothing more concrete is provided.

Owning - Annotation Interface in org.checkerframework.checker.mustcall.qual

Annotation indicating that ownership should be transferred to the annotated element for the purposes of Must Call checking.

P

PACKAGE - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.PACKAGE types.

parameter() - Element in annotation interface org.checkerframework.dataflow.qual.AssertMethod

The one-based index of the boolean parameter that is tested.

PARAMETER - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to all unannotated raw types of formal parameter types, excluding the receiver.

params() - Element in annotation interface org.checkerframework.common.reflection.qual.MethodVal

The number of parameters to the method.

PartialRegex - Annotation Interface in org.checkerframework.checker.regex.qual

Indicates a String that is not a syntactically valid regular expression.

peta - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^15.

pico - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-12.

PolyFenum - Annotation Interface in org.checkerframework.checker.fenum.qual

A polymorphic qualifier for the fake enum type system.

PolyIndex - Annotation Interface in org.checkerframework.checker.index.qual

A polymorphic qualifier for the Lower Bound and Upper Bound type systems.

PolyInitializedFields - Annotation Interface in org.checkerframework.common.initializedfields.qual

Polymorphic qualifier for the Initialized Fields type system.

PolyInterned - Annotation Interface in org.checkerframework.checker.interning.qual

A polymorphic qualifier for the Interning type system.

PolyKeyFor - Annotation Interface in org.checkerframework.checker.nullness.qual

A polymorphic qualifier for the Map Key (@KeyFor) type system.

PolyLength - Annotation Interface in org.checkerframework.checker.index.qual

Syntactic sugar for both @PolyValue and @PolySameLen.

PolyLowerBound - Annotation Interface in org.checkerframework.checker.index.qual

A polymorphic qualifier for the Lower Bound type system.

PolymorphicQualifier - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation that indicates that an annotation is a polymorphic type qualifier.

PolyMustCall - Annotation Interface in org.checkerframework.checker.mustcall.qual

The polymorphic qualifier for the Must Call type system.

PolyNull - Annotation Interface in org.checkerframework.checker.nullness.qual

A polymorphic qualifier for the non-null type system.

PolyPresent - Annotation Interface in org.checkerframework.checker.optional.qual

A polymorphic qualifier for the Optional type system.

PolyRegex - Annotation Interface in org.checkerframework.checker.regex.qual

A polymorphic qualifier for the Regex type system.

PolySameLen - Annotation Interface in org.checkerframework.checker.index.qual

A polymorphic qualifier for the SameLen type system.

PolySignature - Annotation Interface in org.checkerframework.checker.signature.qual

A polymorphic qualifier for the Signature type system.

PolySigned - Annotation Interface in org.checkerframework.checker.signedness.qual

A polymorphic qualifier for the signedness type system.

PolyTainted - Annotation Interface in org.checkerframework.checker.tainting.qual

A polymorphic qualifier for the Tainting type system.

PolyUI - Annotation Interface in org.checkerframework.checker.guieffect.qual

Annotation for the polymorphic-UI effect.

PolyUIEffect - Annotation Interface in org.checkerframework.checker.guieffect.qual

Annotation for the polymorphic effect on methods, or on field accesses.

PolyUIType - Annotation Interface in org.checkerframework.checker.guieffect.qual

Annotation for the polymorphic type declaration.

PolyUnit - Annotation Interface in org.checkerframework.checker.units.qual

A polymorphic qualifier for the units-of-measure type system implemented by the Units Checker.

PolyUpperBound - Annotation Interface in org.checkerframework.checker.index.qual

A polymorphic qualifier for the Upper Bound type system.

PolyValue - Annotation Interface in org.checkerframework.common.value.qual

A polymorphic qualifier for the Constant Value Checker.

Positive - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to an integer greater than or equal to 1.

PostconditionAnnotation - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation that indicates that an annotation E is a postcondition annotation, i.e., E is a type-specialized version of EnsuresQualifier or of EnsuresQualifier.List.

PreconditionAnnotation - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation that indicates that an annotation R is a precondition annotation, i.e., R is a type-specialized version of RequiresQualifier.

prefix() - Element in annotation interface org.checkerframework.checker.units.qual.UnitsMultiple

Returns the scaling prefix.

Prefix - Enum Class in org.checkerframework.checker.units.qual

SI prefixes.

Present - Annotation Interface in org.checkerframework.checker.optional.qual

The Optional container definitely contains a (non-null) value.

PRIMITIVE - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Shorthand for all primitive LiteralKind constants: INT, LONG, FLOAT, DOUBLE, BOOLEAN, CHAR.

primitiveLiteralKinds() - Static method in enum class org.checkerframework.framework.qual.LiteralKind

Returns the primitive LiteralKinds: INT, LONG, FLOAT, DOUBLE, BOOLEAN, CHAR.

PrimitiveType - Annotation Interface in org.checkerframework.checker.signature.qual

A primitive type.

PropertyKey - Annotation Interface in org.checkerframework.checker.propkey.qual

Indicates that the String type can be used as key in a property file or resource bundle.

PropertyKeyBottom - Annotation Interface in org.checkerframework.checker.propkey.qual

The bottom type in the PropertyKeyChecker (and associated checkers) qualifier hierarchy.

Pure - Annotation Interface in org.checkerframework.dataflow.qual

Pure is a method annotation that means both SideEffectFree and Deterministic.

Pure.Kind - Enum Class in org.checkerframework.dataflow.qual

The type of purity.

PurityUnqualified - Annotation Interface in org.checkerframework.framework.qual

An annotation intended solely for representing an unqualified type in the qualifier hierarchy for the Purity Checker.

Q

qualifier() - Element in annotation interface org.checkerframework.framework.qual.ConditionalPostconditionAnnotation

The qualifier that will be established as a postcondition.

qualifier() - Element in annotation interface org.checkerframework.framework.qual.EnsuresQualifier

Returns the qualifier that is guaranteed to hold on successful termination of the method.

qualifier() - Element in annotation interface org.checkerframework.framework.qual.EnsuresQualifierIf

Returns the qualifier that is guaranteed to hold if the method terminates with return value EnsuresQualifierIf.result().

qualifier() - Element in annotation interface org.checkerframework.framework.qual.FieldInvariant

The qualifier on the field.

qualifier() - Element in annotation interface org.checkerframework.framework.qual.PostconditionAnnotation

The qualifier that will be established as a postcondition.

qualifier() - Element in annotation interface org.checkerframework.framework.qual.PreconditionAnnotation

The qualifier that must be established as a precondition.

qualifier() - Element in annotation interface org.checkerframework.framework.qual.RequiresQualifier

Returns the qualifier that is required.

QualifierArgument - Annotation Interface in org.checkerframework.framework.qual

An annotation to use on an element of a contract annotation to indicate that the element specifies the value of an argument of the qualifier.

QualifierForLiterals - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation that indicates what qualifier should be given to literals.

quantity() - Element in annotation interface org.checkerframework.checker.units.qual.UnitsMultiple

Returns the base unit to use.

R

radians - Annotation Interface in org.checkerframework.checker.units.qual

Radians.

RECEIVER - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

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

Regex - Annotation Interface in org.checkerframework.checker.regex.qual

If a type is annotated as @Regex(n), then the run-time value is a regular expression with n capturing groups.

RegexBottom - Annotation Interface in org.checkerframework.checker.regex.qual

The bottom type in the Regex type system.

ReleasesNoLocks - Annotation Interface in org.checkerframework.checker.lock.qual

The method maintains a strictly nondecreasing lock held count on the current thread for any locks that were held prior to the method call.

RelevantJavaTypes - Annotation Interface in org.checkerframework.framework.qual

An annotation on a SourceChecker subclass to specify which Java types are processed by the checker.

ReportCall - Annotation Interface in org.checkerframework.common.util.count.report.qual

Report all calls of a method that has this annotation, including calls of methods that override this method.

ReportCreation - Annotation Interface in org.checkerframework.common.util.count.report.qual

Report all instantiations of a class/interface that has this annotation, including any subclass.

ReportInherit - Annotation Interface in org.checkerframework.common.util.count.report.qual

Report all types that extend/implement a type that has this annotation.

ReportOverride - Annotation Interface in org.checkerframework.common.util.count.report.qual

Report all methods that override a method with this annotation.

ReportReadWrite - Annotation Interface in org.checkerframework.common.util.count.report.qual

Report all read or write access to a field with this annotation.

ReportUnqualified - Annotation Interface in org.checkerframework.common.util.count.report.qual

An annotation intended solely for representing an unqualified type in the qualifier hierarchy for the Report Checker.

ReportUse - Annotation Interface in org.checkerframework.common.util.count.report.qual

Report all uses of a type that has this annotation.

ReportWrite - Annotation Interface in org.checkerframework.common.util.count.report.qual

Report all write accesses to a field with this annotation.

RequiresCalledMethods - Annotation Interface in org.checkerframework.checker.calledmethods.qual

Indicates a method precondition: when the method is invoked, the specified expressions must have had the specified methods called on them.

RequiresCalledMethods.List - Annotation Interface in org.checkerframework.checker.calledmethods.qual

A wrapper annotation that makes the RequiresCalledMethods annotation repeatable.

RequiresNonNull - Annotation Interface in org.checkerframework.checker.nullness.qual

Indicates a method precondition: the method expects the specified expressions to be non-null when the annotated method is invoked.

RequiresNonNull.List - Annotation Interface in org.checkerframework.checker.nullness.qual

A wrapper annotation that makes the RequiresNonNull annotation repeatable.

RequiresPresent - Annotation Interface in org.checkerframework.checker.optional.qual

Indicates a method precondition: the specified expressions of type Optional must be present (i.e., non-empty) when the annotated method is invoked.

RequiresPresent.List - Annotation Interface in org.checkerframework.checker.optional.qual

A wrapper annotation that makes the RequiresPresent annotation repeatable.

RequiresQualifier - Annotation Interface in org.checkerframework.framework.qual

A precondition annotation to indicate that a method requires certain expressions to have a certain qualifier at the time of the call to the method.

RequiresQualifier.List - Annotation Interface in org.checkerframework.framework.qual

A wrapper annotation that makes the RequiresQualifier annotation repeatable.

RESOURCE_VARIABLE - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

Apply default annotations to all unannotated raw types of resource variables.

result() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsIf

Returns the return value of the method under which the postcondition holds.

result() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOfIf

The return value of the method that needs to hold for the postcondition to hold.

result() - Element in annotation interface org.checkerframework.checker.lock.qual.EnsuresLockHeldIf

Returns the return value of the method under which the postconditions hold.

result() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresKeyForIf

The value the method must return, in order for the postcondition to hold.

result() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresNonNullIf

Returns the return value of the method under which the postcondition holds.

result() - Element in annotation interface org.checkerframework.checker.optional.qual.EnsuresPresentIf

Returns the return value of the method under which the postcondition holds.

result() - Element in annotation interface org.checkerframework.common.value.qual.EnsuresMinLenIf

Returns the return value of the method under which the postcondition to hold.

result() - Element in annotation interface org.checkerframework.framework.qual.EnsuresQualifierIf

Returns the return value of the method that needs to hold for the postcondition to hold.

RETURN - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

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

ReturnsFormat - Annotation Interface in org.checkerframework.checker.formatter.qual

Attach this annotation to a method with the following properties: The first parameter is a format string.

ReturnsReceiver - Annotation Interface in org.checkerframework.checker.builder.qual

A deprecated variant of org.checkerframework.common.returnsreceiver.qual.This.

S

s - Annotation Interface in org.checkerframework.checker.units.qual

A second (1/60 of a minute).

SafeEffect - Annotation Interface in org.checkerframework.checker.guieffect.qual

Annotation for the concrete safe effect on methods, or on field accesses.

SafeType - Annotation Interface in org.checkerframework.checker.guieffect.qual

Class declaration annotation to make methods default to @AlwaysSafe.

SameLen - Annotation Interface in org.checkerframework.checker.index.qual

An expression whose type has this annotation evaluates to a value that is a sequence, and that sequence has the same length as the given sequences.

SameLenBottom - Annotation Interface in org.checkerframework.checker.index.qual

The bottom type in the SameLen type system.

SameLenUnknown - Annotation Interface in org.checkerframework.checker.index.qual

This type represents any variable that isn't known to have the same length as another sequence.

SearchIndexBottom - Annotation Interface in org.checkerframework.checker.index.qual

The bottom type in the Search Index type system.

SearchIndexFor - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to an integer whose length is between -a.length - 1 and a.length - 1, inclusive, for all sequences a listed in the annotation.

SearchIndexUnknown - Annotation Interface in org.checkerframework.checker.index.qual

The top type for the SearchIndex type system.

SHORT - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.SHORT types.

SIDE_EFFECT_FREE - Enum constant in enum class org.checkerframework.dataflow.qual.Pure.Kind

The method has no visible side effects.

SideEffectFree - Annotation Interface in org.checkerframework.dataflow.qual

A method is called side-effect-free if it has no visible side-effects, such as setting a field of an object that existed before the method was called.

SignatureBottom - Annotation Interface in org.checkerframework.checker.signature.qual

The bottom type in the Signature String type system.

SignatureUnknown - Annotation Interface in org.checkerframework.checker.signature.qual

Top qualifier in the type hierarchy.

Signed - Annotation Interface in org.checkerframework.checker.signedness.qual

The value is to be interpreted as signed.

SignednessBottom - Annotation Interface in org.checkerframework.checker.signedness.qual

The bottom type in the Signedness type system.

SignednessGlb - Annotation Interface in org.checkerframework.checker.signedness.qual

Client code may interpret the value either as Signed or as Unsigned.

SignedPositive - Annotation Interface in org.checkerframework.checker.signedness.qual

The expression's value is in the signed positive range; that is, its most significant bit is zero.

Speed - Annotation Interface in org.checkerframework.checker.units.qual

Units of speed.

StaticallyExecutable - Annotation Interface in org.checkerframework.common.value.qual

StaticallyExecutable is a method annotation that indicates that the compiler is allowed to run the method at compile time, if all of the method's arguments are compile-time constants.

STRING - Enum constant in enum class org.checkerframework.framework.qual.LiteralKind

Corresponds to Tree.Kind.STRING_LITERAL trees.

stringPatterns() - Element in annotation interface org.checkerframework.framework.qual.QualifierForLiterals

A string literal that matches any of these patterns has this qualifier.

strings - Variable in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

stringToI18nConversionCategory(String) - Static method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Creates a conversion cagetogry from a string name.

StringVal - Annotation Interface in org.checkerframework.common.value.qual

An annotation indicating the possible values for a String type.

StubFiles - Annotation Interface in org.checkerframework.framework.qual

An annotation on a SourceChecker subclass to provide additional stub files that should be used in addition to jdk.astub.

subsequence() - Element in annotation interface org.checkerframework.checker.index.qual.HasSubsequence

An expression that evaluates to the subsequence.

Substance - Annotation Interface in org.checkerframework.checker.units.qual

Units of substance, such as mole (@mol).

SubstringIndexBottom - Annotation Interface in org.checkerframework.checker.index.qual

The bottom type in the Substring Index type system.

SubstringIndexFor - Annotation Interface in org.checkerframework.checker.index.qual

The annotated expression evaluates to either -1 or a non-negative integer less than the lengths of all the given sequences.

SubstringIndexUnknown - Annotation Interface in org.checkerframework.checker.index.qual

The top type for the Substring Index type system.

SubtypeOf - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation to specify all the qualifiers that the given qualifier is an immediate subtype of.

SwingBoxOrientation - Annotation Interface in org.checkerframework.checker.fenum.qual

SwingBoxOrientation.

SwingCompassDirection - Annotation Interface in org.checkerframework.checker.fenum.qual

SwingCompassDirection.

SwingElementOrientation - Annotation Interface in org.checkerframework.checker.fenum.qual

SwingElementOrientation.

SwingHorizontalOrientation - Annotation Interface in org.checkerframework.checker.fenum.qual

SwingHorizontalOrientation.

SwingSplitPaneOrientation - Annotation Interface in org.checkerframework.checker.fenum.qual

SwingSplitPaneOrientation.

SwingTextOrientation - Annotation Interface in org.checkerframework.checker.fenum.qual

SwingTextOrientation.

SwingTitleJustification - Annotation Interface in org.checkerframework.checker.fenum.qual

Vertical orientations for the title text of a TitledBorder.

SwingTitlePosition - Annotation Interface in org.checkerframework.checker.fenum.qual

Justifications for the title text of a TitledBorder.

SwingVerticalOrientation - Annotation Interface in org.checkerframework.checker.fenum.qual

SwingVerticalOrientation.

T

t - Annotation Interface in org.checkerframework.checker.units.qual

Metric ton.

Tainted - Annotation Interface in org.checkerframework.checker.tainting.qual

Denotes a possibly-tainted value: at run time, the value might be tainted or might be untainted.

TargetLocations - Annotation Interface in org.checkerframework.framework.qual

NOTE: This meta-annotation is not currently enforced.

targetValue() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOf

Sequences, each of which is longer than the each of the expressions' value on successful method termination.

targetValue() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOfIf

Sequences, each of which is longer than each of the expressions' value after the method returns the given result.

targetValue() - Element in annotation interface org.checkerframework.common.value.qual.EnsuresMinLenIf

Returns the minimum number of elements in the sequence.

Temperature - Annotation Interface in org.checkerframework.checker.units.qual

Units of temperature.

tera - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^12.

TerminatesExecution - Annotation Interface in org.checkerframework.dataflow.qual

TerminatesExecution is a method annotation that indicates that a method terminates the execution of the program.

This - Annotation Interface in org.checkerframework.common.returnsreceiver.qual

Write @This on the return type of a method that always returns its receiver ( this).

Time - Annotation Interface in org.checkerframework.checker.units.qual

Units of time.

TIME - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if the parameter is a type which is capable of encoding a date or time: long, Long, Calendar, and Date.

to() - Element in annotation interface org.checkerframework.checker.index.qual.HasSubsequence

The index into this, immediately past where the subsequence ends.

to() - Element in annotation interface org.checkerframework.common.value.qual.ArrayLenRange

Largest value in the range, inclusive.

to() - Element in annotation interface org.checkerframework.common.value.qual.IntRange

Largest value in the range, inclusive.

toString() - Method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Returns a pretty printed ConversionCategory.

toString() - Method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Returns a pretty printed I18nConversionCategory.

TypeKind - Enum Class in org.checkerframework.framework.qual

Specifies kinds of types.

typeKinds() - Element in annotation interface org.checkerframework.framework.qual.DefaultFor

Returns TypeKinds of types for which an annotation should be implicitly added.

typeKinds() - Element in annotation interface org.checkerframework.framework.qual.UpperBoundFor

Returns TypeKinds of types that get an upper bound.

types - Variable in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

The argument types.

types - Variable in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

types() - Element in annotation interface org.checkerframework.framework.qual.DefaultFor

Returns Classes for which an annotation should be applied.

types() - Element in annotation interface org.checkerframework.framework.qual.UpperBoundFor

Returns Classes that should get an upper bound.

TypeUseLocation - Enum Class in org.checkerframework.framework.qual

Specifies the locations to which a DefaultQualifier annotation applies.

TYPEVAR - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.TYPEVAR types.

U

UI - Annotation Interface in org.checkerframework.checker.guieffect.qual

Annotation for the UI effect.

UIEffect - Annotation Interface in org.checkerframework.checker.guieffect.qual

Annotation for the concrete UI effect on methods, or on field accesses.

UIPackage - Annotation Interface in org.checkerframework.checker.guieffect.qual

Package annotation to make all classes within a package @UIType.

UIType - Annotation Interface in org.checkerframework.checker.guieffect.qual

Class declaration annotation to make methods default to @UI.

UnderInitialization - Annotation Interface in org.checkerframework.checker.initialization.qual

This type qualifier indicates that an object is (definitely) in the process of being constructed/initialized.

union(ConversionCategory, ConversionCategory) - Static method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Returns the union of two categories.

union(I18nConversionCategory, I18nConversionCategory) - Static method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Returns the union of the two given I18nConversionCategories.

UNION - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.UNION types.

Unique - Annotation Interface in org.checkerframework.common.aliasing.qual

An expression with this type has no aliases.

UnitsBottom - Annotation Interface in org.checkerframework.checker.units.qual

The bottom type in the Units type system.

UnitsMultiple - Annotation Interface in org.checkerframework.checker.units.qual

Define the relation between a base unit and the current unit.

UnitsRelations - Annotation Interface in org.checkerframework.checker.units.qual

Specify the class that knows how to handle the meta-annotated unit when put in relation (plus, multiply, ...) with another unit.

UnknownClass - Annotation Interface in org.checkerframework.common.reflection.qual

Represents a Class object whose run-time value is not known at compile time.

UnknownCompilerMessageKey - Annotation Interface in org.checkerframework.checker.compilermsgs.qual

A String that might or might not be a compiler message key.

UnknownFormat - Annotation Interface in org.checkerframework.checker.formatter.qual

The top qualifier.

UnknownInitialization - Annotation Interface in org.checkerframework.checker.initialization.qual

This type qualifier indicates how much of an object has been fully initialized.

UnknownInterned - Annotation Interface in org.checkerframework.checker.interning.qual

The top qualifier for the Interning Checker.

UnknownKeyFor - Annotation Interface in org.checkerframework.checker.nullness.qual

Used internally by the type system; should never be written by a programmer.

UnknownLocalizableKey - Annotation Interface in org.checkerframework.checker.i18n.qual

Indicates that the String type has an unknown localizable key property.

UnknownLocalized - Annotation Interface in org.checkerframework.checker.i18n.qual

Indicates that the String type has unknown localization properties.

UnknownMethod - Annotation Interface in org.checkerframework.common.reflection.qual

Represents a Method or Constructor expression whose run-time value is not known at compile time.

UnknownPropertyKey - Annotation Interface in org.checkerframework.checker.propkey.qual

Indicates that the String type has an unknown property key property.

UnknownRegex - Annotation Interface in org.checkerframework.checker.regex.qual

Represents the top of the Regex qualifier hierarchy.

UnknownSignedness - Annotation Interface in org.checkerframework.checker.signedness.qual

The value's signedness is not known to the Signedness Checker.

UnknownThis - Annotation Interface in org.checkerframework.common.returnsreceiver.qual

The top type for the Returns Receiver Checker's type system.

UnknownUnits - Annotation Interface in org.checkerframework.checker.units.qual

UnknownUnits is the top type of the type hierarchy.

UnknownVal - Annotation Interface in org.checkerframework.common.value.qual

UnknownVal is a type annotation indicating that the expression's value is not known at compile type.

Unqualified - Annotation Interface in org.checkerframework.common.subtyping.qual

A special annotation intended solely for representing an unqualified type in the qualifier hierarchy, as an argument to SubtypeOf.value(), in a type qualifier declaration.

Unsigned - Annotation Interface in org.checkerframework.checker.signedness.qual

The value is to be interpreted as unsigned.

Untainted - Annotation Interface in org.checkerframework.checker.tainting.qual

Denotes a reference that is untainted, i.e.

Unused - Annotation Interface in org.checkerframework.framework.qual

Declares that the field may not be accessed if the receiver is of the specified qualifier type (or any supertype).

UNUSED - Enum constant in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Use if a parameter is not used by the formatter.

UNUSED - Enum constant in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Use if a parameter is not used by the formatter.

UPPER_BOUND - Enum constant in enum class org.checkerframework.framework.qual.TypeUseLocation

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.

UpperBoundBottom - Annotation Interface in org.checkerframework.checker.index.qual

The bottom type in the Upper Bound type system.

UpperBoundFor - Annotation Interface in org.checkerframework.framework.qual

A meta-annotation applied to the declaration of a type qualifier.

UpperBoundLiteral - Annotation Interface in org.checkerframework.checker.index.qual

A literal value.

UpperBoundUnknown - Annotation Interface in org.checkerframework.checker.index.qual

A variable not known to have a relation to any sequence length.

UsesObjectEquals - Annotation Interface in org.checkerframework.checker.interning.qual

Class declaration to indicate the class does not override equals(Object), and therefore a.equals(b) and a == b behave identically.

V

value() - Element in annotation interface org.checkerframework.checker.builder.qual.CalledMethods

The names of methods that have definitely been called.

value() - Element in annotation interface org.checkerframework.checker.builder.qual.NotCalledMethods

The names of the methods that have NOT been called.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.CalledMethods

Methods that have definitely been called on the expression whose type is annotated.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.CalledMethodsPredicate

A boolean expression constructed from the following grammar:

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethods.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethods

The Java expressions that will have methods called on them.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsIf.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsOnException.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsOnException

Returns Java expressions that have had the given methods called on them after the method throws an exception.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsVarArgs

Returns the methods guaranteed to be invoked on the varargs parameters.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.RequiresCalledMethods.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.calledmethods.qual.RequiresCalledMethods

The Java expressions that must have had methods called on them.

value() - Element in annotation interface org.checkerframework.checker.fenum.qual.Fenum

value() - Element in annotation interface org.checkerframework.checker.formatter.qual.Format

An array of ConversionCategory, indicating the types of legal remaining arguments when a value of the annotated type is used as the first argument to Formatter.format and similar methods.

value() - Element in annotation interface org.checkerframework.checker.formatter.qual.InvalidFormat

Using a value of the annotated type as the first argument to Formatter.format or similar methods will lead to this exception message.

value() - Element in annotation interface org.checkerframework.checker.i18nformatter.qual.I18nFormat

An array of I18nConversionCategory, indicating the types of legal remaining arguments when a value of the annotated type is used as the first argument to Message.format.

value() - Element in annotation interface org.checkerframework.checker.i18nformatter.qual.I18nFormatFor

Indicates which formal parameter is the arguments to the format method.

value() - Element in annotation interface org.checkerframework.checker.i18nformatter.qual.I18nInvalidFormat

Using a value of the annotated type as the first argument to MessageFormat.format(String, Object...) will lead to this exception message.

value() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOf.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOf

The Java expressions that are less than the length of the given sequences on successful method termination.

value() - Element in annotation interface org.checkerframework.checker.index.qual.EnsuresLTLengthOfIf.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.index.qual.IndexFor

Sequences that the annotated expression is a valid index for.

value() - Element in annotation interface org.checkerframework.checker.index.qual.IndexOrHigh

Sequences that the annotated expression is a valid index for or is equal to the lengeth of.

value() - Element in annotation interface org.checkerframework.checker.index.qual.IndexOrLow

Sequences that the annotated expression is a valid index for (or it's -1).

value() - Element in annotation interface org.checkerframework.checker.index.qual.LengthOf

Sequences that the annotated expression is equal to the length of.

value() - Element in annotation interface org.checkerframework.checker.index.qual.LessThan

The annotated expression's value is less than this expression.

value() - Element in annotation interface org.checkerframework.checker.index.qual.LTEqLengthOf

Sequences, each of which is at least as long as the annotated expression's value.

value() - Element in annotation interface org.checkerframework.checker.index.qual.LTLengthOf

Sequences, each of which is longer than the annotated expression's value.

value() - Element in annotation interface org.checkerframework.checker.index.qual.LTOMLengthOf

Sequences, each of whose lengths is at least 1 larger than the annotated expression's value.

value() - Element in annotation interface org.checkerframework.checker.index.qual.NegativeIndexFor

Sequences for which this value is a "negative index"; that is, the expression is in the range -1 to -a.length - 1, inclusive, for each sequence a given here.

value() - Element in annotation interface org.checkerframework.checker.index.qual.SameLen

A list of other sequences with the same length.

value() - Element in annotation interface org.checkerframework.checker.index.qual.SearchIndexFor

Sequences for which the annotated expression has the type of the result of a call to Arrays.binarySearch.

value() - Element in annotation interface org.checkerframework.checker.index.qual.SubstringIndexFor

Sequences, each of which is longer than the annotated expression plus the corresponding offset.

value() - Element in annotation interface org.checkerframework.checker.index.qual.UpperBoundLiteral

Returns the value of the literal.

value() - Element in annotation interface org.checkerframework.checker.initialization.qual.UnderInitialization

The type-frame down to which the expression (of this type) has been initialized at least (inclusive).

value() - Element in annotation interface org.checkerframework.checker.initialization.qual.UnknownInitialization

The type-frame down to which the expression (of this type) has been initialized at least (inclusive).

value() - Element in annotation interface org.checkerframework.checker.lock.qual.EnsuresLockHeld.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.lock.qual.EnsuresLockHeld

Returns Java expressions whose values are locks that are held after successful method termination.

value() - Element in annotation interface org.checkerframework.checker.lock.qual.EnsuresLockHeldIf.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.lock.qual.GuardedBy

The Java value expressions that need to be held.

value() - Element in annotation interface org.checkerframework.checker.lock.qual.GuardSatisfied

The index on the GuardSatisfied polymorphic qualifier, if any.

value() - Element in annotation interface org.checkerframework.checker.lock.qual.Holding

The Java expressions that need to be held.

value() - Element in annotation interface org.checkerframework.checker.mustcall.qual.CreatesMustCallFor.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.mustcall.qual.CreatesMustCallFor

Returns the expression whose must-call type is reset after a call to a method with this annotation.

value() - Element in annotation interface org.checkerframework.checker.mustcall.qual.InheritableMustCall

Methods that might need to be called on the expression whose type is annotated.

value() - Element in annotation interface org.checkerframework.checker.mustcall.qual.MustCall

Methods that might need to be called on the expression whose type is annotated.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.AssertNonNullIfNonNull

Java expression(s) that are non-null after the method returns a non-null value.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresKeyFor.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresKeyFor

Java expressions that are keys in the given maps on successful method termination.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresKeyForIf.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresNonNull.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresNonNull

Returns Java expressions that are NonNull after successful method termination.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.EnsuresNonNullIf.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.KeyFor

Java expression(s) that evaluate to a map for which the annotated type is a key.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.RequiresNonNull.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.nullness.qual.RequiresNonNull

The Java expressions that need to be NonNull.

value() - Element in annotation interface org.checkerframework.checker.optional.qual.EnsuresPresent

The expression (of Optional type) that is present, if the method returns normally.

value() - Element in annotation interface org.checkerframework.checker.optional.qual.EnsuresPresentIf.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.optional.qual.RequiresPresent.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.checker.optional.qual.RequiresPresent

The Java expressions that that need to be Present.

value() - Element in annotation interface org.checkerframework.checker.regex.qual.PartialRegex

The String qualified by this annotation.

value() - Element in annotation interface org.checkerframework.checker.regex.qual.Regex

The number of groups in the regular expression.

value() - Element in annotation interface org.checkerframework.checker.units.qual.A

value() - Element in annotation interface org.checkerframework.checker.units.qual.cd

value() - Element in annotation interface org.checkerframework.checker.units.qual.g

value() - Element in annotation interface org.checkerframework.checker.units.qual.K

value() - Element in annotation interface org.checkerframework.checker.units.qual.m

value() - Element in annotation interface org.checkerframework.checker.units.qual.m2

value() - Element in annotation interface org.checkerframework.checker.units.qual.mol

value() - Element in annotation interface org.checkerframework.checker.units.qual.mPERs

value() - Element in annotation interface org.checkerframework.checker.units.qual.mPERs2

value() - Element in annotation interface org.checkerframework.checker.units.qual.N

value() - Element in annotation interface org.checkerframework.checker.units.qual.radians

value() - Element in annotation interface org.checkerframework.checker.units.qual.s

value() - Element in annotation interface org.checkerframework.checker.units.qual.UnitsRelations

Returns the subclass of UnitsRelations to use.

value() - Element in annotation interface org.checkerframework.common.initializedfields.qual.EnsuresInitializedFields.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.common.initializedfields.qual.EnsuresInitializedFields

The object whose fields this method initializes.

value() - Element in annotation interface org.checkerframework.common.initializedfields.qual.InitializedFields

Fields that have been initialized.

value() - Element in annotation interface org.checkerframework.common.reflection.qual.ClassBound

The binary name of the class or classes that upper-bound the values of this Class object.

value() - Element in annotation interface org.checkerframework.common.reflection.qual.ClassVal

The name of the type that this Class object represents.

value() - Element in annotation interface org.checkerframework.common.value.qual.ArrayLen

The possible lengths of the array.

value() - Element in annotation interface org.checkerframework.common.value.qual.BoolVal

The values that the expression might evaluate to.

value() - Element in annotation interface org.checkerframework.common.value.qual.DoesNotMatchRegex

A set of Java regular expressions.

value() - Element in annotation interface org.checkerframework.common.value.qual.DoubleVal

The values that the expression might evaluate to.

value() - Element in annotation interface org.checkerframework.common.value.qual.EnsuresMinLenIf.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.common.value.qual.EnumVal

The simple names of the possible enum values for an expression with the annotated type.

value() - Element in annotation interface org.checkerframework.common.value.qual.IntVal

The values that the expression might evaluate to.

value() - Element in annotation interface org.checkerframework.common.value.qual.MatchesRegex

A set of Java regular expressions.

value() - Element in annotation interface org.checkerframework.common.value.qual.MinLen

The minimum number of elements in this sequence.

value() - Element in annotation interface org.checkerframework.common.value.qual.StringVal

The values that the expression might evaluate to.

value() - Element in annotation interface org.checkerframework.dataflow.qual.AssertMethod

The class of the exception thrown by this method.

value() - Element in annotation interface org.checkerframework.framework.qual.AnnotatedFor

Returns the type systems for which the class has been annotated.

value() - Element in annotation interface org.checkerframework.framework.qual.CFComment

Comments about Checker Framework annotations.

value() - Element in annotation interface org.checkerframework.framework.qual.Covariant

The zero-based indices of the type parameters that should be treated covariantly.

value() - Element in annotation interface org.checkerframework.framework.qual.DefaultFor

Returns the locations to which the annotation should be applied.

value() - Element in annotation interface org.checkerframework.framework.qual.DefaultQualifier.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.framework.qual.DefaultQualifier

The Class for the default annotation.

value() - Element in annotation interface org.checkerframework.framework.qual.DefaultQualifierForUse

Qualifier to add to all unannotated uses of the type with this declaration annotation.

value() - Element in annotation interface org.checkerframework.framework.qual.EnsuresQualifier.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.framework.qual.EnsuresQualifierIf.List

Return the repeatable annotations.

value() - Element in annotation interface org.checkerframework.framework.qual.HasQualifierParameter

Class of the top qualifier for the hierarchy for which this class has a qualifier parameter.

value() - Element in annotation interface org.checkerframework.framework.qual.MonotonicQualifier

value() - Element in annotation interface org.checkerframework.framework.qual.NoDefaultQualifierForUse

Top qualifier in hierarchies for which no default annotation for use should be applied.

value() - Element in annotation interface org.checkerframework.framework.qual.NoQualifierParameter

Class of the top qualifier for the hierarchy for which this class has no qualifier parameter.

value() - Element in annotation interface org.checkerframework.framework.qual.PolymorphicQualifier

Indicates which type system this annotation refers to (optional, and usually unnecessary).

value() - Element in annotation interface org.checkerframework.framework.qual.QualifierArgument

Specifies the name of the argument of the qualifier, that is passed the values held in the annotated element.

value() - Element in annotation interface org.checkerframework.framework.qual.QualifierForLiterals

The kinds of literals whose types have this qualifier.

value() - Element in annotation interface org.checkerframework.framework.qual.RelevantJavaTypes

Classes where a type annotation supported by this checker may be written.

value() - Element in annotation interface org.checkerframework.framework.qual.RequiresQualifier.List

Returns the repeatable annotations.

value() - Element in annotation interface org.checkerframework.framework.qual.StubFiles

Stub file names.

value() - Element in annotation interface org.checkerframework.framework.qual.SubtypeOf

An array of the supertype qualifiers of the annotated qualifier.

value() - Element in annotation interface org.checkerframework.framework.qual.TargetLocations

Type uses at which the qualifier is permitted to be written in source code.

valueOf(String) - Static method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.checkerframework.checker.units.qual.Prefix

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.checkerframework.dataflow.qual.Pure.Kind

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.checkerframework.framework.qual.LiteralKind

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.checkerframework.framework.qual.TypeKind

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.checkerframework.framework.qual.TypeUseLocation

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.checkerframework.checker.formatter.qual.ConversionCategory

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.checkerframework.checker.units.qual.Prefix

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.checkerframework.dataflow.qual.Pure.Kind

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.checkerframework.framework.qual.LiteralKind

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.checkerframework.framework.qual.TypeKind

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.checkerframework.framework.qual.TypeUseLocation

Returns an array containing the constants of this enum class, in the order they are declared.

VOID - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.VOID types.

Volume - Annotation Interface in org.checkerframework.checker.units.qual

Units of volume.

W

when() - Element in annotation interface org.checkerframework.framework.qual.Unused

The field that is annotated with @Unused may not be accessed via a receiver that is annotated with the "when" annotation.

WILDCARD - Enum constant in enum class org.checkerframework.framework.qual.TypeKind

Corresponds to TypeKind.WILDCARD types.

Y

yocto - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-24.

yotta - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^24.

Z

zepto - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^-21.

zetta - Enum constant in enum class org.checkerframework.checker.units.qual.Prefix

SI prefix for 10^21.

A B C D E F G H I J K L M N O P Q R S T U V W Y Z
All Classes and Interfaces|All Packages