Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractTypeProcessor - Class in org.checkerframework.javacutil
-
This class is an abstract annotation processor designed to be a convenient superclass for concrete "type processors", processors that require the type information in the processed source.
- AbstractTypeProcessor() - Constructor for class org.checkerframework.javacutil.AbstractTypeProcessor
-
Constructor for subclasses to call.
- add(AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- addAll(Collection<? extends AnnotationMirror>) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- annotationBinaryName(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the binary name of an annotation as a String.
- AnnotationBuilder - Class in org.checkerframework.javacutil
-
Builds an annotation mirror that may have some values.
- AnnotationBuilder(ProcessingEnvironment, CharSequence) - Constructor for class org.checkerframework.javacutil.AnnotationBuilder
-
Create a new AnnotationBuilder for the given annotation name (with no elements/fields, but they can be added later).
- AnnotationBuilder(ProcessingEnvironment, Class<? extends Annotation>) - Constructor for class org.checkerframework.javacutil.AnnotationBuilder
-
Create a new AnnotationBuilder for the given annotation and environment (with no elements/fields, but they can be added later).
- AnnotationBuilder(ProcessingEnvironment, AnnotationMirror) - Constructor for class org.checkerframework.javacutil.AnnotationBuilder
-
Create a new AnnotationBuilder that copies the given annotation, including its elements/fields.
- AnnotationFormatter - Interface in org.checkerframework.javacutil
-
Converts AnnotationMirrors to Strings.
- annotationFromAnnotationTree(AnnotationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Converts the given AnnotationTree to an AnnotationMirror.
- AnnotationMirrorMap<V> - Class in org.checkerframework.javacutil
-
The Map interface defines some of its methods with respect to the equals method.
- AnnotationMirrorMap() - Constructor for class org.checkerframework.javacutil.AnnotationMirrorMap
-
Default constructor.
- AnnotationMirrorMap(Map<AnnotationMirror, ? extends V>) - Constructor for class org.checkerframework.javacutil.AnnotationMirrorMap
-
Creates an annotation mirror map and adds all the mappings in
copy
. - AnnotationMirrorSet - Class in org.checkerframework.javacutil
-
The Set interface defines many methods with respect to the equals method.
- AnnotationMirrorSet() - Constructor for class org.checkerframework.javacutil.AnnotationMirrorSet
-
Default constructor.
- AnnotationMirrorSet(Collection<? extends AnnotationMirror>) - Constructor for class org.checkerframework.javacutil.AnnotationMirrorSet
-
Returns a new
AnnotationMirrorSet
that contains the given annotation mirrors. - AnnotationMirrorSet(AnnotationMirror) - Constructor for class org.checkerframework.javacutil.AnnotationMirrorSet
-
Creates a new
AnnotationMirrorSet
that containsvalue
. - annotationMirrorToClass(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Converts an AnnotationMirror to a Class.
- annotationName(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the fully-qualified name of an annotation as a String.
- annotationNameInterned(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the fully-qualified name of an annotation as a String.
- AnnotationProvider - Interface in org.checkerframework.javacutil
-
An implementation of AnnotationProvider returns annotations on Java AST elements.
- annotationsFromArrayCreation(NewArrayTree, int) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Converts the given NewArrayTree to a list of AnnotationMirrors.
- annotationsFromTree(AnnotatedTypeTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Converts the given AnnotatedTypeTree to a list of AnnotationMirrors.
- annotationsFromTree(TypeParameterTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Converts the given TypeParameterTree to a list of AnnotationMirrors.
- annotationsFromTypeAnnotationTrees(List<? extends AnnotationTree>) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Converts the given AnnotationTrees to AnnotationMirrors.
- AnnotationUtils - Class in org.checkerframework.javacutil
-
A utility class for working with annotations.
- annotationValueContains(AnnotationValue, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if an AnnotationValue list contains the given value.
- annotationValueContains(List<? extends AnnotationValue>, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if an AnnotationValue list contains the given value.
- annotationValueContainsToString(AnnotationValue, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if an AnnotationValue list contains a value whose
toString()
is the given string. - annotationValueContainsToString(List<? extends AnnotationValue>, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if an AnnotationValue list contains a value whose
toString()
is the given string. - annotationValueListToEnumArray(List<AnnotationValue>, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Converts a list of AnnotationValue to an array of enum.
- annotationValueListToEnumArray(AnnotationValue, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Converts a list of AnnotationValue to an array of enum.
- annotationValueToList(List<? extends AnnotationValue>, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Converts an annotation value to a list.
- annotationValueToList(AnnotationValue, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Converts an annotation value to a list.
- areSame(Collection<? extends AnnotationMirror>, Collection<? extends AnnotationMirror>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Checks that two collections contain the same annotations.
- areSame(AnnotationMirror, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true iff both annotations are of the same type and have the same annotation values.
- areSame(TypeVariable, TypeVariable) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if the two type variables are the same type variable.
- areSameByClass(AnnotationMirror, Class<? extends Annotation>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Deprecated.
- areSameByName(AnnotationMirror, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Checks that the annotation
am
has the nameaname
(a fully-qualified type name). - areSameByName(AnnotationMirror, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Return true iff a1 and a2 have the same annotation type.
- areSameDeclaredTypes(Type.ClassType, Type.ClassType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the arguments are both the same declared types.
- areSamePrimitiveTypes(TypeMirror, TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the arguments are both the same primitive type.
- ARRAY_CTOR - Enum constant in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
ArrayType # new
- asFieldAccess(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return the field that
tree
is a field access expression for, or null. - asSuper(TypeMirror, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns
type
assuperType
ifsuperType
is a super type oftype
; otherwise, null. - attributeFromAnnotationValue(ExecutableElement, AnnotationValue, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Returns a newly created Attribute corresponding to an argument AnnotationValue.
- available(InputStream) - Static method in class org.checkerframework.javacutil.SystemUtil
-
Calls
InputStream.available()
, but returns null instead of throwing an IOException.
B
- BasicAnnotationProvider - Class in org.checkerframework.javacutil
-
An AnnotationProvider that is independent of any type hierarchy.
- BasicAnnotationProvider() - Constructor for class org.checkerframework.javacutil.BasicAnnotationProvider
- BasicTypeProcessor - Class in org.checkerframework.javacutil
-
Process the types in an AST in a trivial manner, with hooks for derived classes to actually do something.
- BasicTypeProcessor() - Constructor for class org.checkerframework.javacutil.BasicTypeProcessor
- binaryName(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the binary name of a type.
- bindingPatternTreeGetVariable(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- BOUND - Enum constant in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Expr # instMethod
- BugInCF - Exception in org.checkerframework.javacutil
-
Exception type indicating a bug in the framework.
- BugInCF(String) - Constructor for exception org.checkerframework.javacutil.BugInCF
-
Constructs a new BugInCF with the specified detail message and no cause (use this at the root cause).
- BugInCF(String, Object...) - Constructor for exception org.checkerframework.javacutil.BugInCF
-
Constructs a new BugInCF with a detail message composed from the given arguments, and with no cause (use the current callstack as the root cause).
- BugInCF(String, Throwable) - Constructor for exception org.checkerframework.javacutil.BugInCF
-
Constructs a new BugInCF with the specified detail message and cause.
- BugInCF(Throwable) - Constructor for exception org.checkerframework.javacutil.BugInCF
-
Constructs a new BugInCF with the specified cause.
- BugInCF(Throwable, String, Object...) - Constructor for exception org.checkerframework.javacutil.BugInCF
-
Constructs a new BugInCF with the specified cause and with a detail message composed from the given arguments.
- build() - Method in class org.checkerframework.javacutil.AnnotationBuilder
- buildArrayAccess(ExpressionTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to dereference an array.
- buildArrayLengthAccess(ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to dereference the length field of an array.
- buildAssignment(ExpressionTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to assign an RHS expression to an LHS expression.
- buildAssignment(VariableTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to assign an expression to a variable.
- buildBinary(TypeMirror, Tree.Kind, ExpressionTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to perform a binary operation.
- buildClassUse(Element) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to refer to a class name.
- buildCloseMethodAccess(ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Build a
MemberSelectTree
for accessing theclose
method of an expression that implementsAutoCloseable
. - buildHasNextMethodAccess(ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to access the hasNext() method of an iterator.
- buildIteratorMethodAccess(ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to access the iterator() method of some iterable expression.
- buildLessThan(ExpressionTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to compare two operands with less than.
- buildLiteral(Object) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree representing a literal value of primitive or String type.
- buildMethodContext() - Method in class org.checkerframework.javacutil.Resolver
-
Build an instance of
Resolve$MethodResolutionContext
. - buildMethodInvocation(ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to call a method designated by the argument expression.
- buildMethodInvocation(ExpressionTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to call a method designated by methodExpr, with one argument designated by argExpr.
- buildNewArray(TypeMirror, List<ExpressionTree>) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to create a new array with initializers.
- buildNextMethodAccess(ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to access the next() method of an iterator.
- buildPrimValueMethodAccess(Tree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to access the *Value() method of a boxed type such as Short or Float, where * is the corresponding primitive type (i.e.
- buildTypeCast(TypeMirror, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to cast the type of an expression.
- buildValueOfMethodAccess(Tree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to access the valueOf() method of boxed type such as Short or Float.
- buildVariableDecl(Tree, String, Element, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to declare and initialize a variable.
- buildVariableDecl(TypeMirror, String, Element, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to declare and initialize a variable, with no modifiers.
- buildVariableUse(VariableTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Builds an AST Tree to refer to a variable.
C
- canBeNarrowingPrimitiveConversion(TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if the type is byte, short, char, Byte, Short, or Character.
- canHaveTypeAnnotation(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return
true
if and only iftree
can have a type annotation. - caseTreeGetBody(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- caseTreeGetExpressions(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- ceiling(AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- classAndMethodTreeKinds() - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the set of kinds that represent classes and methods.
- classExtendsTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a class extends TypeAnnotationPosition.
- classTreeKinds() - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return the set of kinds that represent classes.
- clear() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- clear() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- cloneElements(C) - Static method in class org.checkerframework.javacutil.CollectionUtils
-
Deprecated.use org.plumelib.util.CollectionsPlume.cloneElements
- cloneElements(M) - Static method in class org.checkerframework.javacutil.CollectionUtils
-
Deprecated.use org.plumelib.util.CollectionsPlume.cloneElements
- cloneElements(Pair<T1, T2>) - Static method in class org.checkerframework.javacutil.Pair
-
Deprecated.Returns a copy of this in which each element is a clone of the corresponding element of this.
- cloneValues(M) - Static method in class org.checkerframework.javacutil.CollectionUtils
-
Deprecated.use org.plumelib.util.CollectionsPlume.cloneValues
- CollectionUtils - Class in org.checkerframework.javacutil
-
Utility methods related to Java Collections.
- colonSplitter - Static variable in class org.checkerframework.javacutil.SystemUtil
-
A splitter that splits on colons.
- combineResults(R1, R1) - Method in class org.checkerframework.javacutil.SwitchExpressionScanner.FunctionalSwitchExpressionScanner
- combineResults(R, R) - Method in class org.checkerframework.javacutil.SwitchExpressionScanner
-
This method combines the result of two calls to
SwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object)
ornull
and the result of one call toSwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object)
. - commaSplitter - Static variable in class org.checkerframework.javacutil.SystemUtil
-
A splitter that splits on commas.
- comparator() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- compareAnnotationMirrors(AnnotationMirror, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Provide an ordering for
AnnotationMirror
s. - compareByName(AnnotationMirror, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Return -1, 0, or 1 depending on whether the name of a1 is less, equal to, or greater than that of a2 (lexicographically).
- compareDiagnosticPosition(Tree, Tree) - Static method in class org.checkerframework.javacutil.InternalUtils
-
Compares tree1 to tree2 by the position at which a diagnostic (e.g., an error message) for the tree should be printed.
- constructor(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromUse instead
- contains(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- containsAll(Collection<?>) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- containsKey(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- containsSame(Collection<? extends AnnotationMirror>, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Checks that the collection contains the annotation.
- containsSameByClass(Collection<? extends AnnotationMirror>, Class<? extends Annotation>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Checks that the collection contains the annotation.
- containsSameByName(Collection<? extends AnnotationMirror>, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Checks that the collection contains an annotation of the given name.
- containsSameByName(Collection<? extends AnnotationMirror>, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Checks that the collection contains an annotation of the given name.
- containsThisConstructorInvocation(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the first statement in the body is a self constructor invocation within a constructor.
- containsValue(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- copyElementValuesFromAnnotation(AnnotationMirror, String...) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Copies every element value from the given annotation.
- copyElementValuesFromAnnotation(AnnotationMirror, Collection<ExecutableElement>) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Copies every element value from the given annotation.
- copyRenameElementValuesFromAnnotation(AnnotationMirror, Map<String, String>) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Copies the specified element values from the given annotation, using the specified renaming map.
- copyTAPosition(TypeAnnotationPosition) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Copy a TypeAnnotationPosition.
- createArrayType(TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns an
ArrayType
with elements of typecomponentType
. - createCompoundFromAnnotationMirror(AnnotationMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Returns a newly created Attribute.Compound corresponding to an argument AnnotationMirror.
- createLiteral(TypeTag, Object, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Creates a LiteralTree for the given value.
- createLRUCache(int) - Static method in class org.checkerframework.javacutil.CollectionUtils
-
Deprecated.use org.plumelib.util.CollectionsPlume.createLruCache
- createTreePathScanner(CompilationUnitTree) - Method in class org.checkerframework.javacutil.BasicTypeProcessor
-
Create a TreePathScanner at the given root.
- createTypeCompoundFromAnnotationMirror(AnnotationMirror, TypeAnnotationPosition, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Returns a newly created Attribute.TypeCompound corresponding to an argument AnnotationMirror.
- createWildcard(TypeMirror, TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Creates a wildcard with the given bounds.
- currentRoot - Variable in class org.checkerframework.javacutil.BasicTypeProcessor
-
The source tree that's being scanned.
D
- decl - Variable in class org.checkerframework.javacutil.trees.DetachedVarSymbol
- declarationTreeKinds() - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return the set of kinds that represent declarations: classes, methods, and variables.
- deepCopy() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- deepCopy() - Method in interface org.checkerframework.javacutil.DeepCopyable
-
Deprecated.Returns a deep copy of this.
- deepCopy(C) - Static method in class org.checkerframework.javacutil.CollectionUtils
-
Deprecated.use org.plumelib.util.CollectionsPlume.deepCopy
- deepCopy(M) - Static method in class org.checkerframework.javacutil.CollectionUtils
-
Deprecated.use org.plumelib.util.CollectionsPlume.deepCopy
- deepCopy(Pair<T1, T2>) - Static method in class org.checkerframework.javacutil.Pair
-
Deprecated.Returns a deep copy of this: each element is a deep copy (according to the
DeepCopyable
interface) of the corresponding element of this. - DeepCopyable<T> - Interface in org.checkerframework.javacutil
-
Deprecated.use org.plumelib.util.DeepCopyable
- deepCopyFirst(Pair<T1, T2>) - Static method in class org.checkerframework.javacutil.Pair
-
Deprecated.Returns a copy, where the
first
element is deep: thefirst
element is a deep copy (according to theDeepCopyable
interface), and thesecond
element is identical to the argument. - deepCopyOrNull(T2) - Static method in interface org.checkerframework.javacutil.DeepCopyable
-
Deprecated.Returns the deep copy of a non-null argument, or
null
for anull
argument. - deepCopySecond(Pair<T1, T2>) - Static method in class org.checkerframework.javacutil.Pair
-
Deprecated.Returns a copy, where the
second
element is deep: thefirst
element is identical to the argument, and thesecond
element is a deep copy (according to theDeepCopyable
interface). - deepCopyValues(M) - Static method in class org.checkerframework.javacutil.CollectionUtils
-
Deprecated.use org.plumelib.util.CollectionsPlume.deepCopyValues
- DefaultAnnotationFormatter - Class in org.checkerframework.javacutil
-
A utility for converting AnnotationMirrors to Strings.
- DefaultAnnotationFormatter() - Constructor for class org.checkerframework.javacutil.DefaultAnnotationFormatter
- descendingIterator() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- descendingSet() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- DetachedVarSymbol - Class in org.checkerframework.javacutil.trees
-
A DetachedVarSymbol represents a variable that is not part of any AST Tree.
- DetachedVarSymbol(long, Name, Type, Symbol) - Constructor for class org.checkerframework.javacutil.trees.DetachedVarSymbol
-
Construct a detached variable symbol, given its flags, name, type and owner.
- dotSplitter - Static variable in class org.checkerframework.javacutil.SystemUtil
-
A splitter that splits on periods.
E
- elementFromDeclaration(ClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the type element corresponding to the given class declaration.
- elementFromDeclaration(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
- elementFromDeclaration(MemberSelectTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromUse
- elementFromDeclaration(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromUse
- elementFromDeclaration(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for the given method declaration.
- elementFromDeclaration(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromUse
- elementFromDeclaration(VariableTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the VariableElement corresponding to the given variable declaration.
- elementFromTree(ClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- elementFromTree(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the element corresponding to the given tree.
- elementFromTree(MemberSelectTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromUse
- elementFromTree(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromUse
- elementFromTree(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromDeclaration
- elementFromTree(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromUse
- elementFromTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the
Element
for the given Tree API node. - elementFromTree(VariableTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromDeclaration
- elementFromUse(ClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- elementFromUse(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Gets the element for the declaration corresponding to this use of an element.
- elementFromUse(MemberReferenceTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for the method reference.
- elementFromUse(MemberSelectTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the element for the given expression.
- elementFromUse(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for the called method.
- elementFromUse(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromDeclaration
- elementFromUse(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Gets the ExecutableElement for the called constructor, from a constructor invocation.
- elementFromUse(VariableTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.use elementFromDeclaration
- elementNamesValues(String, Object) - Static method in class org.checkerframework.javacutil.AnnotationBuilder
-
Creates a mapping between element/field names and values.
- elements - Variable in class org.checkerframework.javacutil.trees.TreeBuilder
-
The javac
Elements
object. - ElementUtils - Class in org.checkerframework.javacutil
-
Utility methods for analyzing
Element
s. - emptyMap() - Static method in class org.checkerframework.javacutil.AnnotationMirrorMap
-
Returns an empty set.
- emptySet() - Static method in class org.checkerframework.javacutil.AnnotationMirrorSet
-
Returns an empty set.
- enclosingClass(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the enclosing class of the tree node defined by the given
TreePath
. - enclosingDeclarationPath(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the path to nearest enclosing declaration (class, method, or variable) of the tree node defined by the given
TreePath
. - enclosingMethod(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the enclosing method of the tree node defined by the given
TreePath
. - enclosingMethodOrLambda(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the enclosing method or lambda expression of the tree node defined by the given
TreePath
. - enclosingNonParen(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the first (innermost) enclosing tree in path, that is not a parenthesis.
- enclosingOfClass(TreePath, Class<T>) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the first (innermost) enclosing tree in path, of the given class.
- enclosingOfKind(TreePath, Tree.Kind) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the first (innermost) enclosing tree in path, of the given kind.
- enclosingOfKind(TreePath, Set<Tree.Kind>) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the first (innermost) enclosing tree in path, with any one of the given kinds.
- enclosingPackage(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the innermost package element enclosing the given element.
- enclosingTopLevelBlock(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Returns the top-level block that encloses the given path, or null if none does.
- enclosingTypeElement(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the innermost type element that is, or encloses, the given element.
- enclosingVariable(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets the enclosing variable of a tree node defined by the given
TreePath
. - entrySet() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- env - Variable in class org.checkerframework.javacutil.trees.TreeBuilder
-
The javac
ProcessingEnvironment
- equals(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- equals(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- equals(Object) - Method in class org.checkerframework.javacutil.Pair
-
Deprecated.
F
- fieldTAPosition(int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a field TypeAnnotationPosition.
- findClass(String, TreePath) - Method in class org.checkerframework.javacutil.Resolver
-
Finds the class literal with name
name
. - findClassInPackage(String, Symbol.PackageSymbol, TreePath) - Method in class org.checkerframework.javacutil.Resolver
-
Finds the class with name
name
in a given package. - findConcreteUpperBound(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Given a bounded type (wildcard or typevar) get the concrete type of its upper bound.
- findElement(CharSequence) - Method in class org.checkerframework.javacutil.AnnotationBuilder
- findField(String, TypeMirror, TreePath) - Method in class org.checkerframework.javacutil.Resolver
-
Finds the field with name
name
intype
or a superclass or superinterface oftype
. - findFieldInType(TypeElement, String) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the field of the class or
null
if not found. - findFieldsInType(TypeElement, Collection<String>) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the elements of the fields whose simple names are in
names
and are declared intype
. - findFieldsInTypeOrSuperType(TypeMirror, Collection<String>) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns non-private field elements, and side-effects
names
to remove them. - findFunction(Tree, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
The type of the lambda or method reference tree is a functional interface type.
- findFunction(TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
This method returns the single abstract method declared by
functionalInterfaceType
. - findFunctionType(TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
This method returns the type of the single abstract method declared by
functionalInterfaceType
. - findLocalVariableOrParameter(String, TreePath) - Method in class org.checkerframework.javacutil.Resolver
-
Finds the local variable (including formal parameters) with name
name
in the given scope. - findMethod(String, TypeMirror, TreePath, List<TypeMirror>) - Method in class org.checkerframework.javacutil.Resolver
-
Finds the method element for a given name and list of expected parameter types.
- findNearestEnclosingElement(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Retrieves the nearest enclosing method or class element for the specified path in the AST.
- findPackage(String, TreePath) - Method in class org.checkerframework.javacutil.Resolver
-
Finds the package with name
name
. - first - Variable in class org.checkerframework.javacutil.Pair
-
Deprecated.The first element of the pair.
- first() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- firstStatement(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the first statement of the tree if it is a block.
- floor(AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- formatAnnotationMirror(AnnotationMirror) - Method in interface org.checkerframework.javacutil.AnnotationFormatter
-
Converts an individual annotation mirror into a String.
- formatAnnotationMirror(AnnotationMirror) - Method in class org.checkerframework.javacutil.DefaultAnnotationFormatter
-
Returns the string representation of a single AnnotationMirror, without showing full package names.
- formatAnnotationMirror(AnnotationMirror, StringBuilder) - Method in class org.checkerframework.javacutil.DefaultAnnotationFormatter
-
A helper method to output a single AnnotationMirror, without showing full package names.
- formatAnnotationMirrorArg(AnnotationValue, StringBuilder) - Method in class org.checkerframework.javacutil.DefaultAnnotationFormatter
- formatAnnotationString(Collection<? extends AnnotationMirror>, boolean) - Method in interface org.checkerframework.javacutil.AnnotationFormatter
-
Converts a collection of annotation mirrors into a String.
- formatAnnotationString(Collection<? extends AnnotationMirror>, boolean) - Method in class org.checkerframework.javacutil.DefaultAnnotationFormatter
-
Creates a String of each annotation in annos separated by a single space character and terminated by a space character, obeying the printInvisible parameter.
- freshTypeVariable(TypeMirror, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Creates a fresh type variable with bounds
upper
andlower
. - freshTypeVariable(TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
If
typeMirror
is a wildcard, returns a fresh type variable that will be used as a captured type variable for it. - fromClass(Elements, Class<? extends Annotation>) - Static method in class org.checkerframework.javacutil.AnnotationBuilder
-
Creates an
AnnotationMirror
that uses default values for elements/fields. - fromClass(Elements, Class<? extends Annotation>, Map<String, AnnotationValue>) - Static method in class org.checkerframework.javacutil.AnnotationBuilder
-
Creates an
AnnotationMirror
given by a particular annotation class and a name-to-value mapping for the elements/fields. - fromName(Elements, CharSequence) - Static method in class org.checkerframework.javacutil.AnnotationBuilder
-
Creates an
AnnotationMirror
given by a particular fully-qualified name. - fromName(Elements, CharSequence, Map<String, AnnotationValue>) - Static method in class org.checkerframework.javacutil.AnnotationBuilder
-
Creates an
AnnotationMirror
given by a particular fully-qualified name and element/field values. - FunctionalSwitchExpressionScanner(BiFunction<ExpressionTree, P1, R1>, BiFunction<R1, R1, R1>) - Constructor for class org.checkerframework.javacutil.SwitchExpressionScanner.FunctionalSwitchExpressionScanner
-
Creates a
SwitchExpressionScanner.FunctionalSwitchExpressionScanner
that uses the given functions.
G
- get(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- getAllFieldsIn(TypeElement, Elements) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Return all fields declared in the given type or any superclass/interface.
- getAllMethodsIn(TypeElement, Elements) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Return all methods declared in the given type or any superclass/interface.
- getAllSupertypes(TypeElement, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Get all the supertypes of a given type, including the type itself.
- getAllTypeElementsIn(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Return all nested/inner classes/interfaces declared in the given type.
- getAnnotationByClass(Collection<? extends AnnotationMirror>, Class<? extends Annotation>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the AnnotationMirror in
c
that has the same class asanno
. - getAnnotationByName(Collection<? extends AnnotationMirror>, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the AnnotationMirror in
c
that has the same name asanno
. - getAnnotationElt() - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Returns the type element of the annotation that is being built.
- getAnnotationMirror(Tree, Class<? extends Annotation>) - Method in interface org.checkerframework.javacutil.AnnotationProvider
-
Return the annotation on
tree
that is in the hierarchy that contains the qualifiertarget
. - getAnnotationMirror(Tree, Class<? extends Annotation>) - Method in class org.checkerframework.javacutil.BasicAnnotationProvider
-
Return the annotation on
tree
that is in the hierarchy that contains the qualifiertarget
. - getArrayDepth(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the depth of an array type.
- getBinaryName(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the binary name of the given type.
- getBody(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.CaseUtils
-
Returns the body of the case statement if it is of the form
case <expression> -> <expression>
. - getCapturedWildcard(TypeVariable) - Static method in class org.checkerframework.javacutil.TypesUtils
-
If
typeVar
is a captured type variable, then returns its underlying wildcard; otherwise returnsnull
. - getCases(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.SwitchExpressionUtils
-
Returns the cases of
switchExpressionTree
. - getClassFromType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the
Class
for a givenTypeMirror
. - getClassLoaderForClass(Class<? extends Object>) - Static method in class org.checkerframework.javacutil.InternalUtils
-
Obtain the class loader for
clazz
. - getCompilerLog() - Method in class org.checkerframework.javacutil.AbstractTypeProcessor
-
Return the compiler log, which contains errors and warnings.
- getConstantExpression(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.ConstantCaseLabelUtils
-
Wrapper around
ConstantCaseLabelTree#getConstantExpression
. - getContextForPolyExpression(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Returns the tree representing the context for the poly expression which is the leaf of
treePath
. - getDeclAnnotation(Element, Class<? extends Annotation>) - Method in interface org.checkerframework.javacutil.AnnotationProvider
-
Returns the AnnotationMirror, of the given class or an alias of it, used to annotate the element.
- getDeclAnnotation(Element, Class<? extends Annotation>) - Method in class org.checkerframework.javacutil.BasicAnnotationProvider
-
Returns the AnnotationMirror, of the given class, used to annotate the element.
- getDeclaration() - Method in class org.checkerframework.javacutil.trees.DetachedVarSymbol
-
Get the declaration tree for the variable.
- getDeconstructor(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.DeconstructionPatternUtils
-
Returns the deconstruction type of
tree
. - getDefaultValueTree(TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return a tree for the default value of the given type.
- getDirectSuperTypeElements(TypeElement, Elements) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Determine all type elements for the direct supertypes of the given type element.
- getElementKindsForElementType(ElementType) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the set of
ElementKind
s corresponding toelementType
. - getElementKindsForTarget(Target) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the set of
ElementKind
s to whichtarget
applies, ignoring TYPE_USE. - getElementValue(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils
- getElementValue(AnnotationMirror, ExecutableElement, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given element of the annotation
anno
. - getElementValue(AnnotationMirror, ExecutableElement, Class<T>, T) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given element of the annotation
anno
. - getElementValueArray(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Deprecated.use
#getElementValueArray(AnnotationMirror, ExecutableElement, Class)
or#getElementValueArray(AnnotationMirror, ExecutableElement, Class, Object)
- getElementValueArray(AnnotationMirror, ExecutableElement, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given element of the annotation
anno
, where the element has an array type. - getElementValueArray(AnnotationMirror, ExecutableElement, Class<T>, List<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given element of the annotation
anno
, where the element has an array type. - getElementValueArrayOrNull(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the element with the name
elementName
of the annotationanno
, or return null if no such element exists. - getElementValueBoolean(AnnotationMirror, ExecutableElement, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given boolean element of the annotation
anno
. - getElementValueClassName(AnnotationMirror, CharSequence, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Deprecated.use an ExecutableElement
- getElementValueClassName(AnnotationMirror, ExecutableElement) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the Name of the class that is referenced by element
element
. - getElementValueClassNames(AnnotationMirror, ExecutableElement) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the list of Names of the classes that are referenced by element
element
. - getElementValueEnum(AnnotationMirror, ExecutableElement, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the element with the name
name
of the annotationanno
. - getElementValueEnum(AnnotationMirror, ExecutableElement, Class<T>, T) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the element with the name
name
of the annotationanno
. - getElementValueEnumArray(AnnotationMirror, ExecutableElement, Class<T>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the element with the name
name
of the annotationanno
. - getElementValueEnumArray(AnnotationMirror, ExecutableElement, Class<T>, T[]) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the element with the name
name
of the annotationanno
. - getElementValueInt(AnnotationMirror, ExecutableElement) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given integer element of the annotation
anno
. - getElementValueInt(AnnotationMirror, ExecutableElement, int) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given integer element of the annotation
anno
. - getElementValueLong(AnnotationMirror, ExecutableElement, long) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the given long element of the annotation
anno
. - getElementValueNotOnClasspath(AnnotationMirror, CharSequence, Class<T>, T) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the element with the name
elementName
of the annotationanno
. - getElementValueOrNull(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Get the element with the name
elementName
of the annotationanno
, or return null if no such element exists. - getEnclosingClassName(ExecutableElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the binary name of the class enclosing
executableElement
. - getEnclosingClassName(VariableElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the binary name of the class enclosing
variableElement
. - getEnumConstants(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns all enum constants declared in the given enumeration.
- getEnvForPath(TreePath) - Method in class org.checkerframework.javacutil.Resolver
-
Determine the environment for the given path.
- getExplicitAnnotationsOnConstructorResult(MethodTree) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the annotations explicitly written on a constructor result.
- getExplicitAnnotationTrees(List<? extends AnnotationTree>, Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the annotations explicitly written on the given type.
- getExpression(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.SwitchExpressionUtils
-
Returns the selector expression of
switchExpressionTree
. - getExpressions(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.CaseUtils
-
Get the list of expressions from a case expression.
- getField(String, String, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the VariableElement for a field declaration.
- getFieldName(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Compute the name of the field that the field access
tree
accesses. - getGuard(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.CaseUtils
-
Returns the guard, the expression after
when
, ofcaseTree
. - getInnermostComponentType(ArrayType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Given an array type, returns the type with all array levels stripped off.
- getJavacContext(ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.InternalUtils
-
Helper function to extract the javac Context from the javac processing environment.
- getJreVersion() - Static method in class org.checkerframework.javacutil.SystemUtil
-
Deprecated.use field
SystemUtil.jreVersion
instead - getKindRecordAsClass(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Calls getKind() on the given tree, but returns CLASS if the Kind is RECORD.
- getKindRecordAsClass(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Calls getKind() on the given Element, but returns CLASS if the ElementKind is RECORD.
- getLabels(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.CaseUtils
-
Get the list of labels from a case expression.
- getMemberReferenceKind(MemberReferenceTree) - Static method in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Returns the kind of member reference
tree
is. - getMethod(String, String, int, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for a method declaration.
- getMethod(String, String, ProcessingEnvironment, String...) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for a method declaration.
- getMethod(Class<?>, String, int, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for a method declaration.
- getMethod(Class<?>, String, ProcessingEnvironment, String...) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for a method declaration.
- getMethodName(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Compute the name of the method that the method access
tree
accesses. - getMethodOrNull(String, String, int, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the ExecutableElement for a method declaration.
- getMethods(String, String, int, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns all ExecutableElements for method declarations of methodName, in class typeName, with params formal parameters.
- getMostSpecificArrayType(TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the most specific supertype of
type
that is an array, or null iftype
is not a subtype of an array. - getNestedPatterns(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.DeconstructionPatternUtils
-
Wrapper around
DeconstructionPatternTree#getNestedPatterns
. - getObjectTypeMirror(ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the
DeclaredType
forjava.lang.Object
. - getOverriddenMethods(ExecutableElement, Types) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the methods that are overridden or implemented by a given method.
- getPathsProperty(String) - Static method in class org.checkerframework.javacutil.SystemUtil
-
Like
System.getProperty
, but splits on the path separator and never returns null. - getPattern(InstanceOfTree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.InstanceOfUtils
-
Returns the pattern of
instanceOfTree
tree. - getPattern(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.PatternCaseLabelUtils
-
Wrapper around
PatternCaseLabelTree#getPattern
. - getPrimitiveConversionKind(PrimitiveType, PrimitiveType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the type of primitive conversion from
from
toto
. - getPrimitiveConversionKind(TypeKind, TypeKind) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Return the type of primitive conversion between
from
andto
. - getQualifiedClassName(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the qualified name of the innermost class enclosing the provided
Element
. - getQualifiedName(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns a verbose name that identifies the element.
- getQualifiedName(DeclaredType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Gets the fully qualified name for a provided type.
- getReceiverTree(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the receiver tree of a field access or a method invocation.
- getRecordComponents(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Calls getRecordComponents on the given TypeElement.
- getReleaseValue(ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.SystemUtil
-
Returns the release value passed to the compiler or null if release was not passed.
- getReturnedExpressions(LambdaExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns all expressions that might be the result of
lambda
. - getSame(Collection<? extends AnnotationMirror>, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the AnnotationMirror in
c
that is the same annotation asanno
. - getSameByName(Collection<? extends AnnotationMirror>, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns the AnnotationMirror in
c
that is the same annotation asanno
ignoring values. - getSimpleDescription(ExecutableElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns a user-friendly name for the given method, which includes the name of the enclosing type.
- getSimpleNameOrDescription(ExecutableElement) - Static method in class org.checkerframework.javacutil.ElementUtils
- getSimpleSignature(ExecutableElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the canonical representation of the method declaration, which contains simple names of the types only.
- getSourceFilePath(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the path to the source file containing
element
, which must be from source code. - getSuperclass(TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the superclass of the given class.
- getSuperClass(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns a type's superclass, or null if it does not have a superclass (it is object or an interface, or the superclass is not on the classpath).
- getSuperClassOrInterface(TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the superclass the given type.
- getSuperConstructor(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the constructor invoked by
newClassTree
unlessnewClassTree
is creating an anonymous class. - getSuperTypes(TypeElement, Elements) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Determine all type elements for the supertypes of the given type element.
- getToolsJar() - Static method in class org.checkerframework.javacutil.SystemUtil
-
Returns the pathname to the tools.jar file, or null if it does not exist.
- getType(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the
TypeMirror
for usage of Element as a value. - getTypeArgumentsToNewClassTree(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the type arguments to the given new class tree.
- getTypeElement(ProcessingEnvironment, Class<?>) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the TypeElement for the given class.
- getTypeElement(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the type element for
type
iftype
is a class, interface, annotation type, or enum. - getTypeVariableLowerBound(TypeVariable, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the lower bound of
typeVariable
. - getValue(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.YieldUtils
-
Returns the value (expression) for
yieldTree
. - getValueOfMethod(ProcessingEnvironment, TypeMirror) - Static method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Returns the valueOf method of a boxed type such as Short or Float.
- getVariable(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.BindingPatternUtils
-
Returns the binding variable of
bindingPatternTree
. - greatestLowerBound(TypeMirror, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the greatest lower bound of two
TypeMirror
s, ignoring any annotations on the types.
H
- hasAnnotation(Element, String) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Given an annotation name, return true if the element has the annotation of that name.
- hasEnclosingType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if
type
has an enclosing type. - hasExplicitConstructor(ClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether the given class contains an explicit constructor.
- hasExplicitExtendsBound(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if
type
is a wildcard with an explicit extends bound. - hasExplicitSuperBound(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if
type
is a wildcard with an explicit super bound. - hashCode() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- hashCode() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- hashCode() - Method in class org.checkerframework.javacutil.Pair
-
Deprecated.
- hasInheritedMeta(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if the given annotation has a @Inherited meta-annotation.
- hasNoExplicitBound(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if
type
is an unbounded wildcard. - hasNullCaseLabel(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if
switchTree
has a null case label. - hasReceiver(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Does the given element need a receiver for accesses? For example, an access to a local variable does not require a receiver.
- hasSyntheticArgument(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if
tree
has a synthetic argument. - hasTypeQualifierElementTypes(ElementType[], Class<?>) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if the given array contains
ElementType.TYPE_USE
, false otherwise. - headSet(AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- headSet(AnnotationMirror, boolean) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- higher(AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
I
- IMPLICIT_INNER - Enum constant in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Inner # new
- inConstructor(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Returns true if the tree is in a constructor or an initializer block.
- init(ProcessingEnvironment) - Method in class org.checkerframework.javacutil.AbstractTypeProcessor
- inSameClass(Element, Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the two elements are in the same class.
- instanceOfTreeGetPattern(InstanceOfTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- InternalUtils - Class in org.checkerframework.javacutil
-
Miscellaneous static utility methods.
- isAnonymous(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is an anonymous type.
- isAnonymousConstructor(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given
MethodTree
is an anonymous constructor (the constructor for an anonymous class). - isAnonymousConstructorWithExplicitEnclosingExpression(ExecutableElement, NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the passed constructor is anonymous and has an explicit enclosing expression.
- isArrayLengthAccess(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if tree is an access of array length.
- isAutoGeneratedRecordMember(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given
Tree
is part of a record that has been automatically generated by the compiler. - isAutoGeneratedRecordMember(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the given
Element
is part of a record that has been automatically generated by the compiler. - isBinaryComparison(BinaryTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the
tree
is a binary tree that performs a comparison. - isBindingPatternTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if
tree
is aBindingPatternTree
. - isBindingVariable(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Return true if the element is a binding variable.
- isBooleanType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if the type is either
boolean
(primitive type) orjava.lang.Boolean
. - isBoxedFloating(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is a boxed floating point type.
- isBoxedPrimitive(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Check if the
type
represents a boxed primitive type. - isBoxOf(TypeMirror, TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if declaredType is a Class that is used to box primitive type (e.g.
- isCallToVarArgsMethodWithZeroVarargsActuals(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given method invocation is an invocation of a method with a vararg parameter, and the invocation has zero vararg actuals.
- isCapturedTypeVariable(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if
type
is a type variable created during capture conversion. - isCaseRule(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- isCaseRule(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.CaseUtils
-
Returns true if this is a case rule (as opposed to a case statement).
- isCharOrCharacter(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if the type is
char
orCharacter
. - isClass(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Checks if the type represents the java.lang.Class declared type.
- isClassElement(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Deprecated.
- isClassLiteral(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether
tree
is a class literal, such as - isClassTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Is the given tree kind a class, i.e.
- isClassType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns whether a TypeMirror represents a class type.
- isCompactCanonicalRecordConstructor(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given
MethodTree
is a compact canonical constructor (the constructor for a record where the parameters are implicitly declared and implicitly assigned to the record's fields). - isCompactCanonicalRecordConstructor(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Check if the given element is a compact canonical record constructor.
- isCompileTimeConstant(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the element is a reference to a compile-time constant.
- isCompileTimeString(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the tree is a constant-time expression.
- isCompoundType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if the given type is a compound type.
- isConstantCaseLabelTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.ConstantCaseLabelUtils
-
Returns true if
tree
is aConstantCaseLabelTree
. - isConstructor(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Checks if the provided method is a constructor method or no.
- isConstructorReference() - Method in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Returns whether this kind is a constructor reference.
- isDeclarationAnnotation(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if anno is a declaration annotation.
- isDeclarationTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given tree is a declaration.
- isDeclaredOfName(TypeMirror, CharSequence) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Check if the type represents a declared type of the given qualified name.
- isDeclaredOfName(TypeMirror, Collection<String>) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Check if the type represents a declared type whose fully-qualified name is any of the given names.
- isDeconstructionPatternTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if
tree
is aDeconstructionPatternTree
. - isDefaultCaseLabelTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.CaseUtils
-
Returns true if
tree
is aDefaultCaseLabelTree
. - isDefaultCaseTree(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- isDefaultCaseTree(CaseTree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.CaseUtils
-
Returns true if this is the default case for a switch statement or expression.
- isDeterministic(ExecutableElement) - Method in interface org.checkerframework.javacutil.AnnotationProvider
-
Returns true if the given method is deterministic according to this AnnotationProvider — that is, if multiple calls to the given method (with the same arguments) return the same value.
- isDeterministic(ExecutableElement) - Method in class org.checkerframework.javacutil.BasicAnnotationProvider
-
Returns true if the given method is deterministic according to this AnnotationProvider — that is, if multiple calls to the given method (with the same arguments) return the same value.
- isDiamondMemberReference(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Is the tree a reference to a constructor of a generic class whose type argument isn't specified? For example,
HashSet::new)
. - isDiamondTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the tree is of a diamond type.
- isEffectivelyFinal(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the element is a effectively final element.
- isElementFromByteCode(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the element is declared in ByteCode.
- isElementFromSourceCode(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Checks whether a given element came from a source file.
- isEmpty() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- isEmpty() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- isEnhancedSwitchStatement(SwitchTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given switch statement tree is an enhanced switch statement, as described in JSL 14.11.2.
- isEnumSuperCall(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if this is a super call to the
Enum
constructor. - isErasedSubtype(TypeMirror, TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if the erased type of
subtype
is a subtype of the erased type ofsupertype
. - isError(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if
element
is "com.sun.tools.javac.comp.Resolve$SymbolNotFoundError". - isExactMethodReference(MemberReferenceTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns whether or not
ref
is an exact method reference. - isExplicitlyTypeLambda(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if
tree
is an explicitly typed lambda. - isExplicitThisDereference(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether the given expression is either "this" or an outer "C.this".
- isExprConstTrue(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether an expression
ExpressionTree
has the constant value true, according to the compiler logic. - isExpressionTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether the given tree represents an ExpressionTree.
- isFieldAccess(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether
tree
is a field access expression, such as - isFinal(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the element is a final element: a final field, method, or final class.
- isFloatingPoint(TypeKind) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Return true if the argument is one of FLOAT, DOUBLE.
- isFloatingPoint(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Return true if the argument TypeMirror is a (possibly boxed) floating point type.
- isFloatingPrimitive(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is a primitive floating point type.
- isFunctionalInterface(TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns whether or not
type
is a functional interface type (as defined in JLS 9.8). - isGetter(ExecutableElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the given element is a getter method.
- isImmutableTypeInJdk(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Return true if this is an immutable type in the JDK.
- isImplicitlyTypedLambda(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if
tree
is an implicitly typed lambda. - isIntegral(TypeKind) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Return true if the argument is one of INT, SHORT, BYTE, CHAR, LONG.
- isIntegralPrimitive(TypeKind) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is an integral primitive type.
- isIntegralPrimitive(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is an integral primitive type.
- isIntegralPrimitiveOrBoxed(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Return true if the argument TypeMirror is a (possibly boxed) integral type.
- isInvisibleQualified(AnnotationMirror) - Static method in class org.checkerframework.javacutil.DefaultAnnotationFormatter
-
Returns true if, by default, anno should not be printed.
- isLikeDiamondMemberReference(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return whether
tree
is a method reference with a raw type to the left of::
. - isLocalVariable(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the tree is the declaration or use of a local variable.
- isLocalVariable(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Return true if the element is a local variable.
- isMethod(ExecutableElement, ExecutableElement, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the given element is, or overrides,
method
. - isMethodAccess(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether
tree
refers to a method element, such as. - isMethodInvocation(Tree, List<ExecutableElement>, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the argument is an invocation of one of the given methods, or of any method that overrides them.
- isMethodInvocation(Tree, ExecutableElement, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given element is an invocation of the method, or of any method that overrides that one.
- isNullExpression(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given tree evaluates to
null
. - isNumeric(TypeKind) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Returns true iff the argument is a primitive numeric type kind.
- isNumeric(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is a primitive numeric type.
- isNumericBoxed(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is a boxed numeric type.
- isObject(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Check if the element is an element for 'java.lang.Object'
- isObject(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Checks if the type represents a java.lang.Object declared type.
- isParameterizedType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if
type
is a parameterized type. - isPatternCaseLabelTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtilsAfterJava11.PatternCaseLabelUtils
-
Returns whether
tree
is aPatternCaseLabelTree
. - isPolyExpression(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns whether or not
expression
is a poly expression as defined in JLS 15.2. - isPrimitive(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is a primitive type.
- isPrimitiveOrBoxed(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true iff the argument is a primitive type or a boxed primitive type.
- isRaw(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Return whether or not
type
is raw. - isRecordAccessor(ExecutableElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the element is a record accessor method.
- isRecordTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether the given tree is of Kind RECORD, in a way that works on all versions of Java.
- isResourceVariable(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true iff the given element is a resource variable.
- isSameTAPosition(TypeAnnotationPosition, TypeAnnotationPosition) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Compare two TypeAnnotationPositions for equality.
- isSameTAPositionExceptTreePos(TypeAnnotationPosition, TypeAnnotationPosition) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Compare two TypeAnnotationPositions for equality, ignoring the source tree position.
- isSelfAccess(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the tree is a tree that 'looks like' either an access of a field or an invocation of a method that are owned by the same accessing instance.
- isSideEffectFree(ExecutableElement) - Method in interface org.checkerframework.javacutil.AnnotationProvider
-
Returns true if the given method is side-effect-free according to this AnnotationProvider — that is, if a call to the given method does not undo flow-sensitive type refinement.
- isSideEffectFree(ExecutableElement) - Method in class org.checkerframework.javacutil.BasicAnnotationProvider
-
Returns true if the given method is side-effect-free according to this AnnotationProvider — that is, if a call to the given method does not undo flow-sensitive type refinement.
- isSpecificFieldAccess(Tree, VariableElement) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if and only if the given
tree
represents a field access of the givenVariableElement
. - isStandaloneExpression(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns whether or not
expression
is a standalone expression as defined in JLS 15.2. - isStatic(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns true if the element is a static element: whether it is a static field, static method, or static class.
- isString(TypeElement) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Check if the element is an element for 'java.lang.String'
- isString(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Checks if the type represents a java.lang.String declared type.
- isStringCompoundConcatenation(CompoundAssignmentTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the compound assignment tree is a string concatenation.
- isStringConcatenation(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the tree represents a
String
concatenation operation. - isSuperConstructorCall(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Checks if the method invocation is a call to super.
- isSwitchExpression(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given tree is a switch expression.
- isSwitchStatement(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given tree is a switch statement (as opposed to a switch expression).
- isSynthetic(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given method is synthetic.
- isSynthetic(ExecutableElement) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given method is synthetic.
- isThisConstructorCall(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Checks if the method invocation is a call to "this".
- isThrowable(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if type represents a Throwable type (e.g.
- isTopLevelAssignmentInInitializerBlock(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Returns true if the path is to a top-level (not within a loop) assignment within an initializer block.
- isTreeInStaticScope(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Returns true if the leaf of the tree path is in a static scope.
- isTypeCompoundContained(List<Attribute.TypeCompound>, Attribute.TypeCompound, Types) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Check whether a TypeCompound is contained in a list of TypeCompounds.
- isTypeDeclaration(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether the given tree represents a declaration of a type (including type parameters).
- isTypeDeclaration(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Return true if the element is a type declaration.
- isTypeElement(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Is the given element kind a type, i.e., a class, enum, interface, or annotation type.
- isTypeTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Is the given tree a type instantiation?
- isUnbound() - Method in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Whether this kind is unbound.
- isUnboundedOrExtendsBounded(WildcardType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if this type is extends bounded or unbounded.
- isUnboundedOrSuperBounded(WildcardType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns true if this type is super bounded or unbounded.
- isUseOfElement(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determine whether the given ExpressionTree has an underlying element.
- isVarArgMethodCall(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Was applicability by variable arity invocation necessary to determine the method signature?
- isVarArgs(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given method invocation is a varargs invocation.
- isVarArgs(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given constructor invocation is a varargs invocation.
- isVarArgs(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given method/constructor invocation is a varargs invocation.
- isVariableTreeDeclaredUsingVar(VariableTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the
variableTree
is declared using thevar
Java keyword. - isVoidReturn(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Is this method's declared return type "void"?
- isWhitespaceOnly(InputStream, int) - Static method in class org.checkerframework.javacutil.SystemUtil
-
Returns true if the first
readLimit
bytes of the input stream consist only of whitespace. - isWideningBinary(BinaryTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the binary operator may do a widening primitive conversion.
- isWildcardParameterized(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Return true if
typeMirror
is a declared type that has at least one wildcard as a type argument. - isYield(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if the given tree is a yield expression.
- iterator() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
J
- javacTypes - Variable in class org.checkerframework.javacutil.trees.TreeBuilder
-
The internal javac
Types
object. - jreVersion - Static variable in class org.checkerframework.javacutil.SystemUtil
-
The major version number of the Java runtime (JRE), such as 8, 11, or 17.
K
- keySet() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- kindToTag(Tree.Kind) - Method in class org.checkerframework.javacutil.trees.TreeBuilder
-
Map public AST Tree.Kinds to internal javac JCTree.Tags.
L
- last() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- leafToStringTruncated(TreePath, int) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Returns a string representation of the leaf of the given path, using
TreeUtils.toStringTruncated(com.sun.source.tree.Tree, int)
. - leastUpperBound(TypeMirror, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the least upper bound of two
TypeMirror
s, ignoring any annotations on the types. - lower(AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
M
- maker - Variable in class org.checkerframework.javacutil.trees.TreeBuilder
-
For constructing trees
- makeUnmodifiable() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
-
Make this set unmodifiable.
- makeUnmodifiable() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
-
Make this set unmodifiable.
- matchesElement(ExecutableElement, String, Class<?>...) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Check that a method Element matches a signature.
- maxValue(TypeKind) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Returns the maximum value representable by the given integral primitive type.
- methodName(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the name of the invoked method.
- methodParameterTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a method parameter TypeAnnotationPosition.
- methodReceiverTAPosition(int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a method receiver TypeAnnotationPosition.
- methodReturnTAPosition(int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a method return TypeAnnotationPosition.
- methodThrowsTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a method throws TypeAnnotationPosition.
- methodTypeParameterBoundTAPosition(int, int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a method type parameter bound TypeAnnotationPosition.
- methodTypeParameterTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a method type parameter TypeAnnotationPosition.
- minValue(TypeKind) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Returns the minimum value representable by the given integral primitive type.
- modelTypes - Variable in class org.checkerframework.javacutil.trees.TreeBuilder
-
The javac
Types
object. - mostSpecific(List<TypeMirror>, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the most specific type from the list, or null if none exists.
N
- nameExpressionToString(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Given a javac ExpressionTree representing a fully qualified name such as "java.lang.Object", creates a String containing the name.
- names - Variable in class org.checkerframework.javacutil.trees.TreeBuilder
-
The javac
Names
object. - NARROWING - Enum constant in enum class org.checkerframework.javacutil.TypeKindUtils.PrimitiveConversionKind
-
The conversion is a narrowing primitive conversion.
- needsTypeArgInference(MemberReferenceTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns whether the method reference tree needs type argument inference.
O
- of(T1, T2) - Static method in class org.checkerframework.javacutil.Pair
-
Deprecated.
- order(Collection<TypeVariable>, Types) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the list of type variables such that a type variable in the list only references type variables at a lower index than itself.
- org.checkerframework.javacutil - package org.checkerframework.javacutil
- org.checkerframework.javacutil.trees - package org.checkerframework.javacutil.trees
P
- Pair<V1,
V2> - Class in org.checkerframework.javacutil -
Deprecated.use org.plumelib.util.IPair
- parentPackage(PackageElement, Elements) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the "parent" package element for the given package element.
- parseTree(String) - Method in class org.checkerframework.javacutil.trees.TreeParser
-
Parses the snippet in the string as an internal Javac AST expression node.
- pathSeparatorSplitter - Static variable in class org.checkerframework.javacutil.SystemUtil
-
A splitter that splits on
File.pathSeparator
. - pathTillClass(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets path to the first (innermost) enclosing class tree, where class is defined by the
TreeUtils.classTreeKinds()
method. - pathTillMethod(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets path to the first (innermost) enclosing method tree.
- pathTillOfKind(TreePath, Tree.Kind) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets path to the first (innermost) enclosing tree of the given kind.
- pathTillOfKind(TreePath, Set<Tree.Kind>) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Gets path to the first (innermost) enclosing tree with any one of the given kinds.
- pollFirst() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- pollLast() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- primitiveOrBoxedToTypeKind(TypeMirror) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Given a primitive type, return its kind.
- process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.checkerframework.javacutil.AbstractTypeProcessor
-
The use of this method is obsolete in type processors.
- put(AnnotationMirror, V) - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- putAll(Map<? extends AnnotationMirror, ? extends V>) - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
R
- readCodePoint(InputStream) - Static method in class org.checkerframework.javacutil.SystemUtil
-
Reads a Unicode code point from an input stream.
- reduce(R, R) - Method in class org.checkerframework.javacutil.SwitchExpressionScanner.YieldVisitor
- remove(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- remove(Object) - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- removeAll(Collection<?>) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- removeElement(CharSequence) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Remove the element/field with the given name.
- Resolver - Class in org.checkerframework.javacutil
-
A utility class to find symbols corresponding to string references (identifiers).
- Resolver(ProcessingEnvironment) - Constructor for class org.checkerframework.javacutil.Resolver
- retainAll(Collection<?>) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
S
- SAME - Enum constant in enum class org.checkerframework.javacutil.TypeKindUtils.PrimitiveConversionKind
-
The two primitive kinds are the same.
- sameAnnotationValue(AnnotationValue, AnnotationValue) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Return true iff the two AnnotationValue objects are the same.
- sameElementValues(AnnotationMirror, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns true if the two annotations have the same elements (fields).
- sameTree(ExpressionTree, ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns true if two expressions originating from the same scope are identical, i.e.
- scan(Tree, P) - Method in class org.checkerframework.javacutil.SwitchExpressionScanner.YieldVisitor
- scanSwitchExpression(Tree, P) - Method in class org.checkerframework.javacutil.SwitchExpressionScanner
-
Scans the given switch expression and calls
SwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object)
on each result expression of the switch expression. - second - Variable in class org.checkerframework.javacutil.Pair
-
Deprecated.The second element of the pair.
- Select(TreeMaker, Tree, Symbol) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the result of
treeMaker.Select(base, sym)
. - Select(TreeMaker, Tree, Name) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the result of
treeMaker.Select(base, name)
. - setDeclaration(VariableTree) - Method in class org.checkerframework.javacutil.trees.DetachedVarSymbol
-
Set the declaration tree for the variable.
- setValue(CharSequence, Boolean) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, Character) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, Class<?>) - Method in class org.checkerframework.javacutil.AnnotationBuilder
- setValue(CharSequence, Double) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, Enum<?>) - Method in class org.checkerframework.javacutil.AnnotationBuilder
- setValue(CharSequence, Enum<?>[]) - Method in class org.checkerframework.javacutil.AnnotationBuilder
- setValue(CharSequence, Float) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, Integer) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, Long) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, Object[]) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, Short) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, String) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, List<? extends Object>) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element/field with the given name, to the given value.
- setValue(CharSequence, VariableElement) - Method in class org.checkerframework.javacutil.AnnotationBuilder
- setValue(CharSequence, VariableElement[]) - Method in class org.checkerframework.javacutil.AnnotationBuilder
- setValue(CharSequence, TypeMirror) - Method in class org.checkerframework.javacutil.AnnotationBuilder
- setValue(ExecutableElement, List<? extends Object>) - Method in class org.checkerframework.javacutil.AnnotationBuilder
-
Set the element to the given value.
- simpleTypeName(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the simple type name, without annotations but including array brackets.
- singleton(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationMirrorSet
-
Returns a new unmodifiable
AnnotationMirrorSet
that containsvalue
. - size() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- size() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- STATIC - Enum constant in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Type # staticMethod
- strictEnclosingTypeElement(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the innermost type element enclosing the given element, that is different from the element itself.
- subSet(AnnotationMirror, boolean, AnnotationMirror, boolean) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- subSet(AnnotationMirror, AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- substitute(TypeMirror, List<? extends TypeMirror>, List<? extends TypeMirror>, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns a new type mirror with the same type as
type
where all the type variables intypeVariables
have been substituted with the type arguments intypeArgs
. - substituteMethodReturnType(Element, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the return type of a method, given the receiver of the method call.
- SUPER - Enum constant in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
super # instMethod
- SwitchExpressionScanner<R,
P> - Class in org.checkerframework.javacutil -
A class that visits each result expression of a switch expression and calls
SwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object)
on each result expression. - SwitchExpressionScanner() - Constructor for class org.checkerframework.javacutil.SwitchExpressionScanner
- SwitchExpressionScanner.FunctionalSwitchExpressionScanner<R1,
P1> - Class in org.checkerframework.javacutil -
An implementation of
SwitchExpressionScanner
that uses functions passed to the constructor forSwitchExpressionScanner.FunctionalSwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object)
andSwitchExpressionScanner.FunctionalSwitchExpressionScanner.combineResults(Object, Object)
. - SwitchExpressionScanner.YieldVisitor - Class in org.checkerframework.javacutil
-
A scanner that visits all the yield trees in a given tree and calls
SwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object)
on the expression in the yield trees. - switchExpressionTreeGetCases(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- switchExpressionTreeGetExpression(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- symtab - Variable in class org.checkerframework.javacutil.trees.TreeBuilder
-
The javac
Symtab
object. - SystemUtil - Class in org.checkerframework.javacutil
-
This file contains basic utility functions.
T
- tailSet(AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- tailSet(AnnotationMirror, boolean) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- toArray() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- toArray(T[]) - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- TOPLEVEL - Enum constant in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Toplevel # new
- toplevelEnclosingTypeElement(Element) - Static method in class org.checkerframework.javacutil.ElementUtils
-
Returns the top-level type element that contains
element
. - toString() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- toString() - Method in class org.checkerframework.javacutil.AnnotationMirrorSet
- toString() - Method in class org.checkerframework.javacutil.Pair
-
Deprecated.
- toString(TreePath) - Static method in class org.checkerframework.javacutil.TreePathUtil
-
Return a printed representation of a TreePath.
- toStringOneLine(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return toString(), but without line separators.
- toStringSimple(AnnotationMirrorSet) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Returns a string representation of the annotation mirrors, using simple (not fully-qualified) names.
- toStringTruncated(Tree, int) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return either
TreeUtils.toStringOneLine(com.sun.source.tree.Tree)
if it is no more thanlength
characters, orTreeUtils.toStringOneLine(com.sun.source.tree.Tree)
quoted and truncated. - TreeBuilder - Class in org.checkerframework.javacutil.trees
-
The TreeBuilder permits the creation of new AST Trees using the non-public Java compiler API TreeMaker.
- TreeBuilder(ProcessingEnvironment) - Constructor for class org.checkerframework.javacutil.trees.TreeBuilder
-
Creates a new TreeBuilder.
- TreeParser - Class in org.checkerframework.javacutil.trees
-
A utility class for parsing Java expression snippets, and converting them to proper Javac AST nodes.
- TreeParser(ProcessingEnvironment) - Constructor for class org.checkerframework.javacutil.trees.TreeParser
-
Create a TreeParser.
- TreePathUtil - Class in org.checkerframework.javacutil
-
Utility methods for obtaining or analyzing a javac
TreePath
. - treeUids - Static variable in class org.checkerframework.javacutil.TreeUtils
-
Unique IDs for trees.
- TreeUtils - Class in org.checkerframework.javacutil
-
Utility methods for analyzing a javac
Tree
. - TreeUtils.MemberReferenceKind - Enum Class in org.checkerframework.javacutil
-
This is a duplication of
com.sun.tools.javac.tree.JCTree.JCMemberReference.ReferenceKind
, which is not part of the supported javac API. - TreeUtilsAfterJava11 - Class in org.checkerframework.javacutil
-
This class contains util methods for reflective accessing Tree classes and methods that were added after Java 11.
- TreeUtilsAfterJava11.BindingPatternUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
BindingPatternTree
methods. - TreeUtilsAfterJava11.CaseUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
CaseTree
methods. - TreeUtilsAfterJava11.ConstantCaseLabelUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
ConstantCaseLabelTree
methods. - TreeUtilsAfterJava11.DeconstructionPatternUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
DeconstructionPatternTree
methods. - TreeUtilsAfterJava11.InstanceOfUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
InstanceOfTree
methods. - TreeUtilsAfterJava11.PatternCaseLabelUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
PatternCaseLabelTree
methods. - TreeUtilsAfterJava11.SwitchExpressionUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
SwitchExpressionTree
methods. - TreeUtilsAfterJava11.YieldUtils - Class in org.checkerframework.javacutil
-
Utility methods for accessing
YieldTree
methods. - TypeAnnotationUtils - Class in org.checkerframework.javacutil
-
A collection of helper methods related to type annotation handling.
- typeElementKinds() - Static method in class org.checkerframework.javacutil.ElementUtils
-
Return the set of kinds that represent classes.
- typeFromClass(Class<?>, Types, Elements) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Returns the
TypeMirror
for a givenClass
. - typeFromUse(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determines the type for a method invocation at its call site, which has all type variables substituted with the type arguments at the call site.
- typeFromUse(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Determines the type for a constructor at its call site given an invocation via
new
, which has all type variables substituted with the type arguments at the call site. - TypeKindUtils - Class in org.checkerframework.javacutil
-
A utility class that helps with
TypeKind
s. - TypeKindUtils.PrimitiveConversionKind - Enum Class in org.checkerframework.javacutil
-
The type of primitive conversion: narrowing, widening, or same.
- typeOf(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the type as a TypeMirror of
tree
. - typeParameterBoundTAPosition(int, int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a type parameter bound TypeAnnotationPosition.
- typeParameterTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create a type parameter TypeAnnotationPosition.
- typeProcess(TypeElement, TreePath) - Method in class org.checkerframework.javacutil.AbstractTypeProcessor
-
Processes a fully-analyzed class that contains a supported annotation (see
AbstractProcessor.getSupportedAnnotationTypes()
). - typeProcess(TypeElement, TreePath) - Method in class org.checkerframework.javacutil.BasicTypeProcessor
-
Visit the tree path for the type element.
- typeProcessingOver() - Method in class org.checkerframework.javacutil.AbstractTypeProcessor
-
A method to be called once all the classes are processed.
- typeProcessingStart() - Method in class org.checkerframework.javacutil.AbstractTypeProcessor
-
A method to be called once before the first call to typeProcess.
- TypesUtils - Class in org.checkerframework.javacutil
-
A utility class that helps with
TypeMirror
s. - TypeSystemError - Exception in org.checkerframework.javacutil
-
Exception type indicating a mistake in a type system built using the Checker Framework.
- TypeSystemError(String) - Constructor for exception org.checkerframework.javacutil.TypeSystemError
-
Constructs a new TypeSystemError with the specified detail message.
- TypeSystemError(String, Object...) - Constructor for exception org.checkerframework.javacutil.TypeSystemError
-
Constructs a new TypeSystemError with a detail message composed from the given arguments.
- typeTreeKinds() - Static method in class org.checkerframework.javacutil.TreeUtils
-
Return the set of kinds that represent types.
U
- unannotatedType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Remove type annotations from the given type.
- UNBOUND - Enum constant in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Type # instMethod
- unknownTAPosition() - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils
-
Create an unknown TypeAnnotationPosition.
- unmodifiableSet(Collection<? extends AnnotationMirror>) - Static method in class org.checkerframework.javacutil.AnnotationMirrorSet
-
Returns an unmodifiable AnnotationMirrorSet with the given elements.
- unmodifiableSet(Map<AnnotationMirror, ? extends V>) - Static method in class org.checkerframework.javacutil.AnnotationMirrorMap
-
Returns an unmodifiable AnnotationMirrorSet with the given elements.
- updateMappingToImmutableSet(Map<T, AnnotationMirrorSet>, T, AnnotationMirrorSet) - Static method in class org.checkerframework.javacutil.AnnotationUtils
-
Update a map, to add
newQual
to the set thatkey
maps to. - upperBound(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils
-
If the argument is a bounded TypeVariable or WildcardType, return its non-variable, non-wildcard upper bound.
- UserError - Exception in org.checkerframework.javacutil
-
Exception type indicating a mistake by an end user in using the Checker Framework, such as incorrect command-line arguments.
- UserError(String) - Constructor for exception org.checkerframework.javacutil.UserError
-
Constructs a new CheckerError with the specified detail message.
- UserError(String, Object...) - Constructor for exception org.checkerframework.javacutil.UserError
-
Constructs a new CheckerError with a detail message composed from the given arguments.
V
- valueOf(String) - Static method in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.checkerframework.javacutil.TypeKindUtils.PrimitiveConversionKind
-
Returns the enum constant of this class with the specified name.
- values() - Method in class org.checkerframework.javacutil.AnnotationMirrorMap
- values() - Static method in enum class org.checkerframework.javacutil.TreeUtils.MemberReferenceKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.checkerframework.javacutil.TypeKindUtils.PrimitiveConversionKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variableElementFromTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the
VariableElement
for the given Tree API node. - variableElementFromUse(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Returns the VariableElement corresponding to the given use.
- visitSwitchResultExpression(ExpressionTree, P) - Method in class org.checkerframework.javacutil.SwitchExpressionScanner
-
This method is called for each result expression of the switch expression passed in
SwitchExpressionScanner.scanSwitchExpression(Tree, Object)
. - visitSwitchResultExpression(ExpressionTree, P1) - Method in class org.checkerframework.javacutil.SwitchExpressionScanner.FunctionalSwitchExpressionScanner
W
- widenedNumericType(TypeKind, TypeKind) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Given two type kinds, return the type kind they are widened to, when an arithmetic operation is performed on them.
- widenedNumericType(TypeMirror, TypeMirror) - Static method in class org.checkerframework.javacutil.TypeKindUtils
-
Returns the widened numeric type for an arithmetic operation performed on a value of the left type and the right type.
- WIDENING - Enum constant in enum class org.checkerframework.javacutil.TypeKindUtils.PrimitiveConversionKind
-
The conversion is a widening primitive conversion.
- wildcardToTypeParam(Type.WildcardType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Get the type parameter for this wildcard from the underlying type's bound field.
- wildcardToTypeParam(WildcardType) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Get the type parameter for this wildcard from the underlying type's bound field.
- wildLowerBound(TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Version of com.sun.tools.javac.code.Types.wildLowerBound(Type) that works with both jdk8 (called upperBound there) and jdk8u.
- wildUpperBound(TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils
-
Version of com.sun.tools.javac.code.Types.wildUpperBound(Type) that works with both jdk8 (called upperBound there) and jdk8u.
- withoutParens(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
If the given tree is a parenthesized tree, return the enclosed non-parenthesized tree.
- withoutParensOrCasts(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
If the given tree is a parenthesized tree or cast tree, return the enclosed non-parenthesized, non-cast tree.
Y
- yieldTreeGetValue(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils
-
Deprecated.
- yieldVisitor - Variable in class org.checkerframework.javacutil.SwitchExpressionScanner
-
A scanner that visits all the yield trees in a given tree and calls
SwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object)
on the expression in the yield trees. - YieldVisitor() - Constructor for class org.checkerframework.javacutil.SwitchExpressionScanner.YieldVisitor
All Classes and Interfaces|All Packages|Serialized Form
AnnotatedTypeFactory#areSameByClass
orAnnotationUtils.areSameByName(javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationMirror)