Uses of Class
org.checkerframework.framework.qual.SubtypeOf
-
-
Uses of SubtypeOf in org.checkerframework.checker.calledmethods.qual
Classes in org.checkerframework.checker.calledmethods.qual with annotations of type SubtypeOf Modifier and Type Class Description interface
CalledMethods
If an expression has type@CalledMethods({"m1", "m2"})
, then methodsm1
andm2
have definitely been called on its value.interface
CalledMethodsBottom
The bottom type for the Called Methods type system.interface
CalledMethodsPredicate
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 SubtypeOf Modifier and Type Class Description interface
CompilerMessageKey
A string that is definitely a compiler message key.interface
CompilerMessageKeyBottom
The bottom type in the Compiler Message Key type system.interface
UnknownCompilerMessageKey
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 SubtypeOf Modifier and Type Class Description interface
AwtAlphaCompositingRule
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
AwtColorSpace
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
AwtCursorType.interface
AwtFlowLayout
Line alignments in a flow layout (seeFlowLayout
for more details).interface
Fenum
A generic fake enumeration qualifier that is parameterized by a name.interface
FenumBottom
The bottom type in the Fenum type system.interface
FenumTop
The top of the fake enumeration type hierarchy.interface
FenumUnqualified
An unqualified type.interface
SwingBoxOrientation
SwingBoxOrientation.interface
SwingCompassDirection
SwingCompassDirection.interface
SwingElementOrientation
SwingElementOrientation.interface
SwingHorizontalOrientation
SwingHorizontalOrientation.interface
SwingSplitPaneOrientation
SwingSplitPaneOrientation.interface
SwingTextOrientation
SwingTextOrientation.interface
SwingTitleJustification
Vertical orientations for the title text of aTitledBorder
.interface
SwingTitlePosition
Justifications for the title text of aTitledBorder
.interface
SwingVerticalOrientation
SwingVerticalOrientation. -
Uses of SubtypeOf in org.checkerframework.checker.formatter.qual
Classes in org.checkerframework.checker.formatter.qual with annotations of type SubtypeOf Modifier and Type Class Description interface
Format
This annotation, attached to a String type, indicates that the String may be passed toFormatter.format
and similar methods.interface
FormatBottom
The bottom type in the Format String type system.interface
InvalidFormat
This annotation, attached to aString
type, indicates that the string is not a legal format string.interface
UnknownFormat
The top qualifier. -
Uses of SubtypeOf in org.checkerframework.checker.guieffect.qual
Classes in org.checkerframework.checker.guieffect.qual with annotations of type SubtypeOf Modifier and Type Class Description interface
AlwaysSafe
Annotation to override the UI effect on a class, and make a field or method safe for non-UI code to use.interface
UI
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 SubtypeOf Modifier and Type Class Description interface
LocalizableKey
Indicates that theString
is a key into a property file or resource bundle containing Localized Strings.interface
LocalizableKeyBottom
The bottom type in the Internationalization type system.interface
Localized
Indicates that theString
type has been localized and formatted for the target output locale.interface
UnknownLocalizableKey
Indicates that theString
type has an unknown localizable key property.interface
UnknownLocalized
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 SubtypeOf Modifier and Type Class Description interface
I18nFormat
This annotation, attached to a String type, indicates that the String may be passed toMessageFormat.format
.interface
I18nFormatBottom
The bottom type in the Internationalization Format String type system.interface
I18nFormatFor
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
I18nInvalidFormat
This annotation, attached to aString
type, indicates that if the String is passed toMessageFormat.format(String, Object...)
, an exception will result.interface
I18nUnknownFormat
The top qualifier. -
Uses of SubtypeOf in org.checkerframework.checker.index.qual
Classes in org.checkerframework.checker.index.qual with annotations of type SubtypeOf Modifier and Type Class Description interface
GTENegativeOne
The annotated expression evaluates to an integer greater than or equal to -1.interface
LessThan
An annotation indicating the relationship between values with a byte, short, char, int, or long type.interface
LessThanBottom
The bottom type in the LessThan type system.interface
LessThanUnknown
The top qualifier for the LessThan type hierarchy.interface
LowerBoundBottom
The bottom type of the lower bound type system.interface
LowerBoundUnknown
The annotated expression evaluates to value that might be -2 or lower.interface
LTEqLengthOf
The annotated expression evaluates to an integer whose value is less than or equal to the lengths of all the given sequences.interface
LTLengthOf
The annotated expression evaluates to an integer whose value is less than the lengths of all the given sequences.interface
LTOMLengthOf
The annotated expression evaluates to an integer whose value is at least 2 less than the lengths of all the given sequences.interface
NegativeIndexFor
The annotated expression is between-1
and-a.length - 1
, inclusive, for each sequencea
listed in the annotation.interface
NonNegative
The annotated expression evaluates to an integer greater than or equal to 0.interface
Positive
The annotated expression evaluates to an integer greater than or equal to 1.interface
SameLen
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
SameLenBottom
The bottom type in the SameLen type system.interface
SameLenUnknown
This type represents any variable that isn't known to have the same length as another sequence.interface
SearchIndexBottom
The bottom type in the Search Index type system.interface
SearchIndexFor
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
SearchIndexUnknown
The top type for the SearchIndex type system.interface
SubstringIndexBottom
The bottom type in the Substring Index type system.interface
SubstringIndexFor
The annotated expression evaluates to either -1 or a non-negative integer less than the lengths of all the given sequences.interface
SubstringIndexUnknown
The top type for the Substring Index type system.interface
UpperBoundBottom
The bottom type in the Upper Bound type system.interface
UpperBoundLiteral
A literal value.interface
UpperBoundUnknown
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 SubtypeOf Modifier and Type Class Description interface
FBCBottom
The bottom type in the initialization type system.interface
Initialized
This type qualifier belongs to the freedom-before-commitment initialization tracking type-system.interface
UnderInitialization
This type qualifier indicates that an object is (definitely) in the process of being constructed/initialized.interface
UnknownInitialization
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 SubtypeOf Modifier and Type Class Description interface
Interned
Indicates that a variable has been interned, i.e., that the variable refers to the canonical representation of an object.interface
InternedDistinct
Indicates that no other value isequals()
to the given value.interface
UnknownInterned
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 SubtypeOf Modifier and Type Class Description interface
GuardedBy
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
GuardedByBottom
The bottom type in the GuardedBy type system.interface
GuardedByUnknown
It is unknown what locks guard the value referred to by the annotated variable.interface
GuardSatisfied
If a variablex
has type@GuardSatisfied
, then all lock expressions forx
's value are held.interface
LockHeld
Indicates that an expression is used as a lock and the lock is known to be held on the current thread.interface
LockPossiblyHeld
Indicates that an expression is not known to beLockHeld
.interface
NewObject
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 SubtypeOf Modifier and Type Class Description interface
MustCall
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
MustCallUnknown
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 SubtypeOf Modifier and Type Class Description interface
KeyFor
Indicates that the value assigned to the annotated variable is a key for at least the given map(s).interface
KeyForBottom
The bottom type in the Map Key type system.interface
MonotonicNonNull
Indicates that once the field (or variable) becomes non-null, it never becomes null again.interface
NonNull
If an expression's type is qualified by@NonNull
, then the expression never evaluates tonull
.interface
Nullable
Nullable
is a type annotation that makes no commitments about whether the value isnull
.interface
UnknownKeyFor
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 Modifier and Type Class Description interface
MaybePresent
TheOptional
container may or may not contain a value.interface
OptionalBottom
The bottom type qualifier for the Optional Checker.interface
Present
TheOptional
container definitely contains a (non-null) value. -
Uses of SubtypeOf in org.checkerframework.checker.propkey.qual
Classes in org.checkerframework.checker.propkey.qual with annotations of type SubtypeOf Modifier and Type Class Description interface
PropertyKey
Indicates that theString
type can be used as key in a property file or resource bundle.interface
PropertyKeyBottom
The bottom type in the PropertyKeyChecker (and associated checkers) qualifier hierarchy.interface
UnknownPropertyKey
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 SubtypeOf Modifier and Type Class Description interface
PartialRegex
Indicates a String that is not a syntactically valid regular expression.interface
Regex
If a type is annotated as@Regex(n)
, then the run-time value is a regular expression with n capturing groups.interface
RegexBottom
The bottom type in the Regex type system.interface
UnknownRegex
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 SubtypeOf Modifier and Type Class Description interface
ArrayWithoutPackage
An identifier or primitive type, followed by any number of array square brackets.interface
BinaryName
Represents a binary name as defined in the Java Language Specification, section 13.1.interface
BinaryNameOrPrimitiveType
Represents a primitive type name or abinary name
.interface
BinaryNameWithoutPackage
interface
CanonicalName
Canonical names have the same syntactic form asfully-qualified name
s.interface
CanonicalNameAndBinaryName
This is a string that is a valid canonical name and a valid binary name.interface
CanonicalNameOrEmpty
Either aCanonicalName
or the empty string.interface
CanonicalNameOrPrimitiveType
This is a string that is a valid canonical name and a valid binary name or primitive type.interface
ClassGetName
The type representation used by theClass.getName()
,Class.forName(String)
, andClass.forName(String, boolean, ClassLoader)
methods.interface
ClassGetSimpleName
The format produced by theClass.getSimpleName()
method.interface
DotSeparatedIdentifiers
This is a string that is a valid fully qualified name and a valid binary name.interface
DotSeparatedIdentifiersOrPrimitiveType
This is a string that is a valid fully qualified name and a valid binary name or primitive type.interface
FieldDescriptor
Represents a field descriptor (JVM type format) as defined in the Java Virtual Machine Specification, section 4.3.2.interface
FieldDescriptorForPrimitive
Represents a field descriptor (JVM type format) for a primitive as defined in the Java Virtual Machine Specification, section 4.3.2.interface
FieldDescriptorWithoutPackage
Represents afield descriptor
for a primitive or for an array whose base type is primitive or in the unnamed package.interface
FqBinaryName
An extension of binary name format to represent primitives and arrays.interface
FullyQualifiedName
A sequence of dot-separated identifiers, followed by any number of array square brackets.interface
Identifier
An identifier.interface
IdentifierOrPrimitiveType
An identifier or a primitive type.interface
InternalForm
The syntax for binary names that appears in a class file, as defined in the JVM Specification, section 4.2.interface
MethodDescriptor
Represents a method descriptor (JVM representation of method signature) as defined in the Java Virtual Machine Specification, section 4.3.3.interface
PrimitiveType
A primitive type.interface
SignatureBottom
The bottom type in the Signature String type system.interface
SignatureUnknown
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 SubtypeOf Modifier and Type Class Description interface
Signed
The value is to be interpreted as signed.interface
SignednessBottom
The bottom type in the Signedness type system.interface
SignednessGlb
interface
SignedPositiveFromUnsigned
The expression is@
SignedPositive
, and its value came from widening a value that is allowed to be interpreted as unsigned.interface
UnknownSignedness
The value's signedness is not known to the Signedness Checker.interface
Unsigned
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 Modifier and Type Class Description interface
Tainted
Denotes a possibly-tainted value: at run time, the value might be tainted or might be untainted.interface
Untainted
Denotes a reference that is untainted, i.e. -
Uses of SubtypeOf in org.checkerframework.checker.units.qual
Classes in org.checkerframework.checker.units.qual with annotations of type SubtypeOf Modifier and Type Class Description interface
A
Ampere.interface
Acceleration
Units of acceleration.interface
Angle
Units of measure for angles.interface
Area
Units of areas.interface
C
Degree Centigrade (Celsius).interface
cd
Candela (unit of luminance).interface
Current
Electric current.interface
degrees
Degrees.interface
Force
Units of force.interface
g
Gram.interface
h
Hour.interface
K
Kelvin (unit of temperature).interface
kg
Kilogram.interface
km
Kilometer.interface
km2
Square kilometer.interface
km3
Cubic kilometer.interface
kmPERh
Kilometer per hour.interface
kN
Kilonewton.interface
Length
Units of length.interface
Luminance
Units of luminance.interface
m
Meter.interface
m2
Square meter.interface
m3
Cubic meter.interface
Mass
Units of mass.interface
min
Minute.interface
MixedUnits
MixedUnits is the result of multiplying or dividing units, where no more specific unit is known from a UnitsRelations implementation.interface
mm
Millimeter.interface
mm2
Square millimeter.interface
mm3
Cubic millimeter.interface
mol
Mole (unit ofSubstance
).interface
mPERs
Meter per second.interface
mPERs2
Meter per second squared.interface
N
Newton.interface
radians
Radians.interface
s
A second (1/60 of a minute).interface
Speed
Units of speed.interface
Substance
Units of substance, such as mole (@mol
).interface
t
Metric ton.interface
Temperature
Units of temperature.interface
Time
Units of time.interface
UnitsBottom
The bottom type in the Units type system.interface
UnknownUnits
UnknownUnits is the top type of the type hierarchy.interface
Volume
Units of volume. -
Uses of SubtypeOf in org.checkerframework.common.aliasing.qual
Classes in org.checkerframework.common.aliasing.qual with annotations of type SubtypeOf Modifier and Type Class Description interface
LeakedToResult
This annotation is used on a formal parameter to indicate that the parameter may be returned, but it is not otherwise leaked.interface
MaybeAliased
An expression with this type might have an alias.interface
MaybeLeaked
Temporary type qualifier:interface
NonLeaked
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
Unique
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 SubtypeOf Modifier and Type Class Description interface
InitializedFields
Indicates which fields have definitely been initialized.interface
InitializedFieldsBottom
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 SubtypeOf Modifier and Type Class Description interface
ClassBound
This represents aClass<T>
object whose run-time value is equal to or a subtype of one of the arguments.interface
ClassVal
This represents aClass<T>
object where the set of possible values of T is known at compile time.interface
ClassValBottom
The bottom type in the ClassVal type system.interface
MethodVal
This represents a set ofMethod
orConstructor
values.interface
MethodValBottom
The bottom type in the MethodVal type system.interface
UnknownClass
Represents a Class object whose run-time value is not known at compile time.interface
UnknownMethod
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 SubtypeOf Modifier and Type Class Description interface
BottomThis
The bottom type for the Returns Receiver Checker's type system.interface
UnknownThis
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 SubtypeOf Modifier and Type Class Description interface
Bottom
A special annotation intended solely for representing the bottom type in the qualifier hierarchy.interface
Unqualified
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 SubtypeOf Modifier and Type Class Description interface
ReportUnqualified
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 SubtypeOf Modifier and Type Class Description interface
ArrayLen
An annotation indicating the length of an array or a string.interface
ArrayLenRange
An expression with this type evaluates to an array or a string whose length is in the given range.interface
BoolVal
An annotation indicating the possible values for a bool type.interface
BottomVal
The bottom type in the Constant Value type system.interface
DoubleVal
An annotation indicating the possible values for a double or float type.interface
IntRange
An expression with this type evaluates to an integral value (byte, short, char, int, or long) in the given range.interface
IntRangeFromGTENegativeOne
An expression with this type is exactly the same as anIntRange
annotation whosefrom
field is-1
and whoseto
field isInteger.MAX_VALUE
.interface
IntRangeFromNonNegative
An expression with this type is exactly the same as anIntRange
annotation whosefrom
field is0
and whoseto
field isInteger.MAX_VALUE
.interface
IntRangeFromPositive
An expression with this type is exactly the same as anIntRange
annotation whosefrom
field is1
and whoseto
field isInteger.MAX_VALUE
.interface
IntVal
An annotation indicating the possible values for a byte, short, char, int, or long type.interface
MatchesRegex
An annotation indicating the possible values for a String type.interface
StringVal
An annotation indicating the possible values for a String type.interface
UnknownVal
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 SubtypeOf Modifier and Type Class Description interface
FromByteCode
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
PurityUnqualified
An annotation intended solely for representing an unqualified type in the qualifier hierarchy for the Purity Checker.
-