Uses of Annotation Type
org.checkerframework.framework.qual.SubtypeOf
Packages that use SubtypeOf
Package
Description
Qualifiers for the Compiler Message Key Checker.
Contains the basic annotations to be used by all type systems and meta-annotations to qualify
annotations (qualifiers).
-
Uses of SubtypeOf in org.checkerframework.checker.calledmethods.qual
Classes in org.checkerframework.checker.calledmethods.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
If an expression has type@CalledMethods({"m1", "m2"})
, then methodsm1
andm2
have definitely been called on its value.@interface
The bottom type for the Called Methods type system.@interface
This annotation represents a predicate on@
CalledMethods
annotations. -
Uses of SubtypeOf in org.checkerframework.checker.compilermsgs.qual
Classes in org.checkerframework.checker.compilermsgs.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
A string that is definitely a compiler message key.@interface
The bottom type in the Compiler Message Key type system.@interface
AString
that might or might not be a compiler message key. -
Uses of SubtypeOf in org.checkerframework.checker.fenum.qual
Classes in org.checkerframework.checker.fenum.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Basic alpha compositing rules for combining source and destination colors to achieve blending and transparency effects with graphics and images (seeAlphaComposite
for more details).@interface
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 (seeColorSpace
for more details).@interface
AwtCursorType.@interface
Line alignments in a flow layout (seeFlowLayout
for more details).@interface
A generic fake enumeration qualifier that is parameterized by a name.@interface
The bottom type in the Fenum type system.@interface
The top of the fake enumeration type hierarchy.@interface
An unqualified type.@interface
SwingBoxOrientation.@interface
SwingCompassDirection.@interface
SwingElementOrientation.@interface
SwingHorizontalOrientation.@interface
SwingSplitPaneOrientation.@interface
SwingTextOrientation.@interface
Vertical orientations for the title text of aTitledBorder
.@interface
Justifications for the title text of aTitledBorder
.@interface
SwingVerticalOrientation. -
Uses of SubtypeOf in org.checkerframework.checker.formatter.qual
Classes in org.checkerframework.checker.formatter.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
This annotation, attached to a String type, indicates that the String may be passed toFormatter.format
and similar methods.@interface
The bottom type in the Format String type system.@interface
This annotation, attached to aString
type, indicates that the string is not a legal format string.@interface
The top qualifier. -
Uses of SubtypeOf in org.checkerframework.checker.guieffect.qual
Classes in org.checkerframework.checker.guieffect.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Annotation to override the UI effect on a class, and make a field or method safe for non-UI code to use.@interface
Annotation for the UI effect. -
Uses of SubtypeOf in org.checkerframework.checker.i18n.qual
Classes in org.checkerframework.checker.i18n.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Indicates that theString
is a key into a property file or resource bundle containing Localized Strings.@interface
The bottom type in the Internationalization type system.@interface
Indicates that theString
type has been localized and formatted for the target output locale.@interface
Indicates that theString
type has an unknown localizable key property.@interface
Indicates that theString
type has unknown localization properties. -
Uses of SubtypeOf in org.checkerframework.checker.i18nformatter.qual
Classes in org.checkerframework.checker.i18nformatter.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
This annotation, attached to a String type, indicates that the String may be passed toMessageFormat.format
.@interface
The bottom type in the Internationalization Format String type system.@interface
This annotation indicates that when a string of the annotated type is passed as the first argument toMessageFormat.format(String, Object...)
, then the expression that is an argument to the annotation can be passed as the remaining arguments, in varargs style.@interface
This annotation, attached to aString
type, indicates that if the String is passed toMessageFormat.format(String, Object...)
, an exception will result.@interface
The top qualifier. -
Uses of SubtypeOf in org.checkerframework.checker.index.qual
Classes in org.checkerframework.checker.index.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
The annotated expression evaluates to an integer greater than or equal to -1.@interface
An annotation indicating the relationship between values with a byte, short, char, int, or long type.@interface
The bottom type in the LessThan type system.@interface
The top qualifier for the LessThan type hierarchy.@interface
The bottom type of the lower bound type system.@interface
The annotated expression evaluates to value that might be -2 or lower.@interface
The annotated expression evaluates to an integer whose value is less than or equal to the lengths of all the given sequences.@interface
The annotated expression evaluates to an integer whose value is less than the lengths of all the given sequences.@interface
The annotated expression evaluates to an integer whose value is at least 2 less than the lengths of all the given sequences.@interface
The annotated expression is between-1
and-a.length - 1
, inclusive, for each sequencea
listed in the annotation.@interface
The annotated expression evaluates to an integer greater than or equal to 0.@interface
The annotated expression evaluates to an integer greater than or equal to 1.@interface
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.@interface
The bottom type in the SameLen type system.@interface
This type represents any variable that isn't known to have the same length as another sequence.@interface
The bottom type in the Search Index type system.@interface
The annotated expression evaluates to an integer whose length is between-a.length - 1
anda.length - 1
, inclusive, for all sequencesa
listed in the annotation.@interface
The top type for the SearchIndex type system.@interface
The bottom type in the Substring Index type system.@interface
The annotated expression evaluates to either -1 or a non-negative integer less than the lengths of all the given sequences.@interface
The top type for the Substring Index type system.@interface
The bottom type in the Upper Bound type system.@interface
A literal value.@interface
A variable not known to have a relation to any sequence length. -
Uses of SubtypeOf in org.checkerframework.checker.initialization.qual
Classes in org.checkerframework.checker.initialization.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
The bottom type in the initialization type system.@interface
This type qualifier belongs to the freedom-before-commitment initialization tracking type-system.@interface
This type qualifier indicates that an object is (definitely) in the process of being constructed/initialized.@interface
This type qualifier indicates how much of an object has been fully initialized. -
Uses of SubtypeOf in org.checkerframework.checker.interning.qual
Classes in org.checkerframework.checker.interning.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Indicates that a variable has been interned, i.e., that the variable refers to the canonical representation of an object.@interface
Indicates that no other value isequals()
to the given value.@interface
The top qualifier for the Interning Checker. -
Uses of SubtypeOf in org.checkerframework.checker.lock.qual
Classes in org.checkerframework.checker.lock.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Indicates that a thread may dereference the value referred to by the annotated variable only if the thread holds all the given lock expressions.@interface
The bottom type in the GuardedBy type system.@interface
It is unknown what locks guard the value referred to by the annotated variable.@interface
If a variablex
has type@GuardSatisfied
, then all lock expressions forx
's value are held.@interface
Indicates that an expression is used as a lock and the lock is known to be held on the current thread.@interface
Indicates that an expression is not known to beLockHeld
.@interface
A type that represents a newly-constructed object. -
Uses of SubtypeOf in org.checkerframework.checker.mustcall.qual
Classes in org.checkerframework.checker.mustcall.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
An expression of type@MustCall({"m1", "m2"})
may be obligated to callm1()
and/orm2()
before it is deallocated, but it is not obligated to call any other methods.@interface
The top qualifier in the Must Call type hierarchy. -
Uses of SubtypeOf in org.checkerframework.checker.nullness.qual
Classes in org.checkerframework.checker.nullness.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Indicates that the value assigned to the annotated variable is a key for at least the given map(s).@interface
The bottom type in the Map Key type system.@interface
Indicates that once the field (or variable) becomes non-null, it never becomes null again.@interface
If an expression's type is qualified by@NonNull
, then the expression never evaluates tonull
.@interface
Nullable
is a type annotation that makes no commitments about whether the value isnull
.@interface
Used internally by the type system; should never be written by a programmer. -
Uses of SubtypeOf in org.checkerframework.checker.optional.qual
Classes in org.checkerframework.checker.optional.qual with annotations of type SubtypeOf -
Uses of SubtypeOf in org.checkerframework.checker.propkey.qual
Classes in org.checkerframework.checker.propkey.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Indicates that theString
type can be used as key in a property file or resource bundle.@interface
The bottom type in the PropertyKeyChecker (and associated checkers) qualifier hierarchy.@interface
Indicates that theString
type has an unknown property key property. -
Uses of SubtypeOf in org.checkerframework.checker.regex.qual
Classes in org.checkerframework.checker.regex.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Indicates a String that is not a syntactically valid regular expression.@interface
If a type is annotated as@Regex(n)
, then the run-time value is a regular expression with n capturing groups.@interface
The bottom type in the Regex type system.@interface
Represents the top of the Regex qualifier hierarchy. -
Uses of SubtypeOf in org.checkerframework.checker.signature.qual
Classes in org.checkerframework.checker.signature.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
An identifier or primitive type, followed by any number of array square brackets.@interface
Represents a binary name as defined in the Java Language Specification, section 13.1.@interface
Represents a primitive type name or abinary name
.@interface
@interface
Canonical names have the same syntactic form asfully-qualified name
s.@interface
This is a string that is a valid canonical name and a valid binary name.@interface
Either aCanonicalName
or the empty string.@interface
This is a string that is a valid canonical name and a valid binary name or primitive type.@interface
The type representation used by theClass.getName()
,Class.forName(String)
, andClass.forName(String, boolean, ClassLoader)
methods.@interface
The format produced by theClass.getSimpleName()
method.@interface
This is a string that is a valid fully qualified name and a valid binary name.@interface
This is a string that is a valid fully qualified name and a valid binary name or primitive type.@interface
Represents a field descriptor (JVM type format) as defined in the Java Virtual Machine Specification, section 4.3.2.@interface
Represents a field descriptor (JVM type format) for a primitive as defined in the Java Virtual Machine Specification, section 4.3.2.@interface
Represents afield descriptor
for a primitive or for an array whose base type is primitive or in the unnamed package.@interface
An extension of binary name format to represent primitives and arrays.@interface
A sequence of dot-separated identifiers, followed by any number of array square brackets.@interface
An identifier.@interface
An identifier or a primitive type.@interface
The syntax for binary names that appears in a class file, as defined in the JVM Specification, section 4.2.@interface
Represents a method descriptor (JVM representation of method signature) as defined in the Java Virtual Machine Specification, section 4.3.3.@interface
A primitive type.@interface
The bottom type in the Signature String type system.@interface
Top qualifier in the type hierarchy. -
Uses of SubtypeOf in org.checkerframework.checker.signedness.qual
Classes in org.checkerframework.checker.signedness.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
The value is to be interpreted as signed.@interface
The bottom type in the Signedness type system.@interface
@interface
The expression is@
SignedPositive
, and its value came from widening a value that is allowed to be interpreted as unsigned.@interface
The value's signedness is not known to the Signedness Checker.@interface
The value is to be interpreted as unsigned. -
Uses of SubtypeOf in org.checkerframework.checker.tainting.qual
Classes in org.checkerframework.checker.tainting.qual with annotations of type SubtypeOf -
Uses of SubtypeOf in org.checkerframework.checker.units.qual
Classes in org.checkerframework.checker.units.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Ampere.@interface
Units of acceleration.@interface
Units of measure for angles.@interface
Units of areas.@interface
Degree Centigrade (Celsius).@interface
Candela (unit of luminance).@interface
Electric current.@interface
Degrees.@interface
Units of force.@interface
Gram.@interface
Hour.@interface
Kelvin (unit of temperature).@interface
Kilogram.@interface
Kilometer.@interface
Square kilometer.@interface
Cubic kilometer.@interface
Kilometer per hour.@interface
Kilonewton.@interface
Units of length.@interface
Units of luminance.@interface
Meter.@interface
Square meter.@interface
Cubic meter.@interface
Units of mass.@interface
Minute.@interface
MixedUnits is the result of multiplying or dividing units, where no more specific unit is known from a UnitsRelations implementation.@interface
Millimeter.@interface
Square millimeter.@interface
Cubic millimeter.@interface
Mole (unit ofSubstance
).@interface
Meter per second.@interface
Meter per second squared.@interface
Newton.@interface
Radians.@interface
A second (1/60 of a minute).@interface
Units of speed.@interface
Units of substance, such as mole (@mol
).@interface
Metric ton.@interface
Units of temperature.@interface
Units of time.@interface
The bottom type in the Units type system.@interface
UnknownUnits is the top type of the type hierarchy.@interface
Units of volume. -
Uses of SubtypeOf in org.checkerframework.common.aliasing.qual
Classes in org.checkerframework.common.aliasing.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
This annotation is used on a formal parameter to indicate that the parameter may be returned, but it is not otherwise leaked.@interface
An expression with this type might have an alias.@interface
Temporary type qualifier:@interface
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.@interface
An expression with this type has no aliases. -
Uses of SubtypeOf in org.checkerframework.common.initializedfields.qual
Classes in org.checkerframework.common.initializedfields.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
Indicates which fields have definitely been initialized.@interface
The bottom type qualifier for the Initialized Fields type system. -
Uses of SubtypeOf in org.checkerframework.common.reflection.qual
Classes in org.checkerframework.common.reflection.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
This represents aClass<T>
object whose run-time value is equal to or a subtype of one of the arguments.@interface
This represents aClass<T>
object where the set of possible values of T is known at compile time.@interface
The bottom type in the ClassVal type system.@interface
This represents a set ofMethod
orConstructor
values.@interface
The bottom type in the MethodVal type system.@interface
Represents a Class object whose run-time value is not known at compile time.@interface
Represents aMethod
orConstructor
expression whose run-time value is not known at compile time. -
Uses of SubtypeOf in org.checkerframework.common.returnsreceiver.qual
Classes in org.checkerframework.common.returnsreceiver.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
The bottom type for the Returns Receiver Checker's type system.@interface
The top type for the Returns Receiver Checker's type system. -
Uses of SubtypeOf in org.checkerframework.common.subtyping.qual
Classes in org.checkerframework.common.subtyping.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
A special annotation intended solely for representing the bottom type in the qualifier hierarchy.@interface
A special annotation intended solely for representing an unqualified type in the qualifier hierarchy, as an argument tovalue()
, in a type qualifier declaration. -
Uses of SubtypeOf in org.checkerframework.common.util.report.qual
Classes in org.checkerframework.common.util.report.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
An annotation intended solely for representing an unqualified type in the qualifier hierarchy for the Report Checker. -
Uses of SubtypeOf in org.checkerframework.common.value.qual
Classes in org.checkerframework.common.value.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
An annotation indicating the length of an array or a string.@interface
An expression with this type evaluates to an array or a string whose length is in the given range.@interface
An annotation indicating the possible values for a bool type.@interface
The bottom type in the Constant Value type system.@interface
An annotation indicating the possible values for a double or float type.@interface
An expression with this type evaluates to an integral value (byte, short, char, int, or long) in the given range.@interface
An expression with this type is exactly the same as anIntRange
annotation whosefrom
field is-1
and whoseto
field isInteger.MAX_VALUE
.@interface
An expression with this type is exactly the same as anIntRange
annotation whosefrom
field is0
and whoseto
field isInteger.MAX_VALUE
.@interface
An expression with this type is exactly the same as anIntRange
annotation whosefrom
field is1
and whoseto
field isInteger.MAX_VALUE
.@interface
An annotation indicating the possible values for a byte, short, char, int, or long type.@interface
An annotation indicating the possible values for a String type.@interface
An annotation indicating the possible values for a String type.@interface
UnknownVal is a type annotation indicating that the expression's value is not known at compile type. -
Uses of SubtypeOf in org.checkerframework.framework.qual
Classes in org.checkerframework.framework.qual with annotations of type SubtypeOfModifier and TypeClassDescription@interface
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.@interface
An annotation intended solely for representing an unqualified type in the qualifier hierarchy for the Purity Checker.