A B C D E F G H I J K L M N O P R S T U V W

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.

AnnotationBuilder - Class in org.checkerframework.javacutil

Builds an annotation mirror that may have some values.

AnnotationBuilder(ProcessingEnvironment, Class<? extends Annotation>) - Constructor for class org.checkerframework.javacutil.AnnotationBuilder

AnnotationBuilder(ProcessingEnvironment, CharSequence) - Constructor for class org.checkerframework.javacutil.AnnotationBuilder

AnnotationBuilder(ProcessingEnvironment, AnnotationMirror) - Constructor for class org.checkerframework.javacutil.AnnotationBuilder

annotationFromAnnotationTree(AnnotationTree) - Static method in class org.checkerframework.javacutil.TreeUtils

annotationName(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

annotationOrdering() - Static method in class org.checkerframework.javacutil.AnnotationUtils

provide ordering for AnnotationMirror based on their fully qualified name.

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

annotationsFromTree(AnnotatedTypeTree) - Static method in class org.checkerframework.javacutil.TreeUtils

annotationsFromTree(TypeParameterTree) - Static method in class org.checkerframework.javacutil.TreeUtils

annotationsFromTypeAnnotationTrees(List<? extends AnnotationTree>) - Static method in class org.checkerframework.javacutil.TreeUtils

AnnotationUtils - Class in org.checkerframework.javacutil

A utility class for working with annotations.

areSame(AnnotationMirror, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Checks if both annotations are the same.

areSame(Collection<? extends AnnotationMirror>, Collection<? extends AnnotationMirror>) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Checks that two collections contain the same annotations.

areSameByClass(AnnotationMirror, Class<? extends Annotation>) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Checks that the annotation am has the name of annoClass.

areSameByName(AnnotationMirror, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Checks that the annotation am has the name aname (a fully-qualified type name).

areSameDeclaredTypes(Type.ClassType, Type.ClassType) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns true iff the arguments are both the same primitive types.

areSameIgnoringValues(AnnotationMirror, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

areSamePrimitiveTypes(TypeMirror, TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns true iff the arguments are both the same primitive types.

asSuper(TypeMirror, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils

attributeFromAnnotationValue(ExecutableElement, AnnotationValue, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

Returns a newly created Attribute corresponding to an argument AnnotationValue.

B

BasicAnnotationProvider - Class in org.checkerframework.javacutil

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

BugInCF - Exception in org.checkerframework.javacutil

Exception type indicating a bug in the framework or in a checker implementation.

BugInCF(String) - Constructor for exception org.checkerframework.javacutil.BugInCF

Constructs a new CheckerError 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 CheckerError with a detail message composed from the given arguments, and with no cause (use this at the root cause).

BugInCF(String, Throwable) - Constructor for exception org.checkerframework.javacutil.BugInCF

Constructs a new CheckerError with the specified detail message and cause.

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(VariableTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder

Builds an AST Tree to assign an expression to a variable.

buildAssignment(ExpressionTree, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder

Builds an AST Tree to assign an RHS expression to an LHS expression.

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.

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(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.

buildVariableDecl(Tree, String, Element, ExpressionTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder

Builds an AST Tree to declare and initialize a variable.

buildVariableUse(VariableTree) - Method in class org.checkerframework.javacutil.trees.TreeBuilder

Builds an AST Tree to refer to a variable.

C

canHaveTypeAnnotation(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

CHECKER_QUAL_PATH_OPT - Static variable in class org.checkerframework.javacutil.PluginUtil

Option name for specifying an alternative checker-qual.jar location.

classExtendsTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

classTreeKinds() - Static method in class org.checkerframework.javacutil.TreeUtils

clear() - Static method in class org.checkerframework.javacutil.AnnotationBuilder

clear() - Static method in class org.checkerframework.javacutil.AnnotationUtils

CollectionUtils - Class in org.checkerframework.javacutil

Utility methods related to Java Collections

CollectionUtils() - Constructor for class org.checkerframework.javacutil.CollectionUtils

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

Determines the symbol for a constructor given an invocation via new.

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 the annotation.

containsSameIgnoringValues(Collection<? extends AnnotationMirror>, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Checks that the collection contains the annotation ignoring values.

containsThisConstructorInvocation(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils

copyElementValuesFromAnnotation(AnnotationMirror, String...) - 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

createAnnotationMap() - Static method in class org.checkerframework.javacutil.AnnotationUtils

Create a map suitable for storing AnnotationMirror as keys.

createAnnotationSet() - Static method in class org.checkerframework.javacutil.AnnotationUtils

Constructs a Set suitable for storing AnnotationMirrors.

createArrayType(TypeMirror, Types) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns an ArrayType with elements of type componentType.

createCompoundFromAnnotationMirror(AnnotationMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

Returns a newly created Attribute.Compound corresponding to an argument AnnotationMirror.

createLRUCache(int) - Static method in class org.checkerframework.javacutil.CollectionUtils

A Utility method for creating LRU cache

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.

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

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.

E

elementFromDeclaration(ClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the element for a class corresponding to a declaration.

elementFromDeclaration(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the element for a method corresponding to a declaration.

elementFromDeclaration(VariableTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the element for a variable corresponding to its declaration.

elementFromTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the Element for the given Tree API node.

elementFromUse(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the element for the declaration corresponding to this use of an element.

elementFromUse(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils

elementFromUse(NewClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Specialization for return type.

elements - Variable in class org.checkerframework.javacutil.trees.TreeBuilder

ElementUtils - Class in org.checkerframework.javacutil

A Utility class for analyzing Elements.

enclosingClass(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns the innermost type element enclosing the given element

enclosingClass(TreePath) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the enclosing class of the tree node defined by the given TreePath.

enclosingMethod(TreePath) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the enclosing method of the tree node defined by the given TreePath.

enclosingMethodOrLambda(TreePath) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the enclosing method or lambda expression of the tree node defined by the given TreePath.

enclosingOfClass(TreePath, Class<T>) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the first enclosing tree in path, of the specified class

enclosingOfKind(TreePath, Tree.Kind) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the first enclosing tree in path, of the specified kind.

enclosingOfKind(TreePath, Set<Tree.Kind>) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the first enclosing tree in path, with any one of the specified 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.TreeUtils

enclosingVariable(TreePath) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets the enclosing variable of a tree node defined by the given TreePath.

env - Variable in class org.checkerframework.javacutil.trees.TreeBuilder

equals(Object) - Method in class org.checkerframework.javacutil.Pair

escapeQuotesAndSlashes(String) - Static method in class org.checkerframework.javacutil.PluginUtil

F

fieldTAPosition(int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

fileArgToStr(File) - Static method in class org.checkerframework.javacutil.PluginUtil

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 in a given type.

findFieldInType(TypeElement, String) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns the field of the class

findFieldsInType(TypeElement, Collection<String>) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns the elements of the fields whose simple names are names and are declared in type.

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.

findLocalVariableOrParameterOrField(String, TreePath) - Method in class org.checkerframework.javacutil.Resolver

Finds the local variable 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.

findPackage(String, TreePath) - Method in class org.checkerframework.javacutil.Resolver

Finds the package with name name.

first - Variable in class org.checkerframework.javacutil.Pair

firstStatement(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

fromClass(Elements, Class<? extends Annotation>) - Static method in class org.checkerframework.javacutil.AnnotationBuilder

Creates an AnnotationMirror given by a particular annotation class.

fromName(Elements, CharSequence) - Static method in class org.checkerframework.javacutil.AnnotationBuilder

Creates an AnnotationMirror given by a particular fully-qualified name.

G

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.

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 as anno.

getAnnotationByName(Collection<? extends AnnotationMirror>, String) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Returns the AnnotationMirror in c that has the same name as anno.

getAnnotationMirror(Tree, Class<? extends Annotation>) - Method in interface org.checkerframework.javacutil.AnnotationProvider

Return the annotation on tree that has the class target.

getAnnotationMirror(Tree, Class<? extends Annotation>) - Method in class org.checkerframework.javacutil.BasicAnnotationProvider

getAssignmentContext(TreePath) - Static method in class org.checkerframework.javacutil.TreeUtils

Returns the tree with the assignment context for the treePath leaf node.

getBooleanProp(Map<PluginUtil.CheckerProp, Object>, PluginUtil.CheckerProp, String) - Static method in class org.checkerframework.javacutil.PluginUtil

If prop is in props, return a 1-element list containing cmdLineArg.

getBooleanSystemProperty(String) - Static method in class org.checkerframework.javacutil.PluginUtil

Return true if the system property is set to "true".

getBooleanSystemProperty(String, boolean) - Static method in class org.checkerframework.javacutil.PluginUtil

Return its boolean value if the system property is set.

getCapturedWildcard(TypeVariable) - Static method in class org.checkerframework.javacutil.TypesUtils

If typeVar is a captured wildcard, returns that wildcard; otherwise returns null.

getClassLoaderForClass(Class<? extends Object>) - Static method in class org.checkerframework.javacutil.InternalUtils

Obtain the class loader for clazz.

getCmd(String, File, File, File, String, String, String, File, String, Map<PluginUtil.CheckerProp, Object>, PrintStream, boolean, String) - Static method in class org.checkerframework.javacutil.PluginUtil

getCmdArgsOnly(File, String, String, String, File, String, Map<PluginUtil.CheckerProp, Object>, PrintStream, boolean, String) - Static method in class org.checkerframework.javacutil.PluginUtil

getCmdArgsOnly(File, File, File, String, String, String, File, String, Map<PluginUtil.CheckerProp, Object>, PrintStream, boolean, String) - Static method in class org.checkerframework.javacutil.PluginUtil

getCmdLine(Map<PluginUtil.CheckerProp, Object>) - Method in enum org.checkerframework.javacutil.PluginUtil.CheckerProp

getDeclAnnotation(Element, Class<? extends Annotation>) - Method in interface org.checkerframework.javacutil.AnnotationProvider

Returns the actual annotation mirror used to annotate this type, whose name equals the passed annotationName if one exists, null otherwise.

getDeclAnnotation(Element, Class<? extends Annotation>) - Method in class org.checkerframework.javacutil.BasicAnnotationProvider

getDeclaration() - Method in class org.checkerframework.javacutil.trees.DetachedVarSymbol

Get the declaration tree for the variable.

getElementKindsForElementType(ElementType) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Returns the set of ElementKinds corresponding to elementType.

getElementKindsForTarget(Target) - Static method in class org.checkerframework.javacutil.AnnotationUtils

getElementValue(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Get the attribute with the name name of the annotation anno.

getElementValueArray(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Get the attribute with the name name of the annotation anno, where the attribute has an array type.

getElementValueClass(AnnotationMirror, CharSequence, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Get the Class that is referenced by attribute name.

getElementValueClassName(AnnotationMirror, CharSequence, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Get the Name of the class that is referenced by attribute name.

getElementValueClassNames(AnnotationMirror, CharSequence, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Get the list of Names of the classes that are referenced by attribute name.

getElementValueEnum(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Version that is suitable for Enum elements.

getElementValueEnumArray(AnnotationMirror, CharSequence, Class<T>, boolean) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Get the attribute with the name name of the annotation anno, or the default value if no attribute is present explicitly, where the attribute has an array type and the elements are Enums.

getElementValuesWithDefaults(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Returns the values of an annotation's attributes, including defaults.

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.

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.

getJavacContext(ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.InternalUtils

Helper function to extract the javac Context from the javac processing environment.

getJavaCommand(String, PrintStream) - Static method in class org.checkerframework.javacutil.PluginUtil

getJdkJarName() - Static method in class org.checkerframework.javacutil.PluginUtil

Determine the version of the JRE that we are currently running and select a jdkX.jar where X is the version of Java that is being run (e.g.

getJdkJarPrefix() - Static method in class org.checkerframework.javacutil.PluginUtil

Determine the version of the JRE that we are currently running and select a jdkX where X is the version of Java that is being run (e.g.

getJreVersion() - Static method in class org.checkerframework.javacutil.PluginUtil

Extract the first two version numbers from java.version (e.g.

getMethod(String, String, int, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TreeUtils

Returns the ExecutableElement for the method declaration of methodName, in class typeName, with params formal parameters.

getMethod(String, String, ProcessingEnvironment, String...) - Static method in class org.checkerframework.javacutil.TreeUtils

Returns the ExecutableElement for a method declaration of methodName, in class typeName, with formal parameters of the given types.

getMethodList(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.

getMethodName(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

Compute the name of the method that the method access tree accesses.

getQualifiedClassName(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns the qualified name of the inner most class enclosing the provided 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

getSame(Collection<? extends AnnotationMirror>, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Returns the AnnotationMirror in c that is the same annotation as anno.

getSameIgnoringValues(Collection<? extends AnnotationMirror>, AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Returns the AnnotationMirror in c that is the same annotation as anno ignoring values.

getStringProp(Map<PluginUtil.CheckerProp, Object>, PluginUtil.CheckerProp, String, String...) - Static method in class org.checkerframework.javacutil.PluginUtil

Returns a list of command-line arguments: one that sets the given property, plus everything in extras.

getSuperTypes(TypeElement, Elements) - Static method in class org.checkerframework.javacutil.ElementUtils

Determine all type elements for the classes and interfaces referenced (directly or indirectly) in the extends/implements clauses of the given type element.

getType(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns the TypeMirror for usage of Element as a value.

getTypeElement(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns the type element for type if type is a class, interface, annotation type, or enum.

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.

getVerboseName(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns a verbose name that identifies the element.

greatestLowerBound(TypeMirror, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns the greatest lower bound of two TypeMirrors, ignoring any annotations on the types.

H

hasElementValue(AnnotationMirror, CharSequence) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Verify whether the attribute with the name name exists in the annotation anno.

hasExplicitConstructor(ClassTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Determine whether the given class contains an explicit constructor.

hashCode() - Method in class org.checkerframework.javacutil.Pair

hasInheritedMeta(AnnotationMirror) - Static method in class org.checkerframework.javacutil.AnnotationUtils

Returns true if the given annotation has a @Inherited meta-annotation.

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.

I

init(ProcessingEnvironment) - Method in class org.checkerframework.javacutil.AbstractTypeProcessor

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

Determines whether or not the node referred to by the given TreePath is an anonymous constructor (the constructor for an anonymous class.

isArrayLengthAccess(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

Returns whether or not tree is an access of array length.

isBooleanType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Checks if the type represents a boolean type, that is either boolean (primitive type) or java.lang.Boolean.

isBoxedPrimitive(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

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.

isCaptured(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns whether a TypeVariable represents a captured type.

isClass(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Checks if the type represents a java.lang.Class declared type.

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.

isCompileTimeConstant(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns true if the element is a constant time reference

isCompileTimeString(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Returns true if the node is a constant-time expression.

isConstructor(MethodTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Checks if the provided method is a constructor method or no.

isDeclaredOfName(TypeMirror, CharSequence) - Static method in class org.checkerframework.javacutil.TypesUtils

Check if the type represents a declared type of the given qualified name.

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.

isEnumSuper(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils

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 of supertype.

isError(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

isExplicitThisDereference(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Determine whether the given expression is either "this" or an outer "C.this".

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 expressions, such as

isFinal(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

Returns true if the element is a final element: a final field, final method, or final class

isFloating(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns true iff the argument is a 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).

isGetClassInvocation(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils

isImplicitlyTypedLambda(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

Returns true if tree is an implicitly typed lambda.

isIntegral(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns true iff the argument is an integral type.

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, 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.

isNamedMethodCall(String, MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Checks if the method call is a call to the given method name.

isNumeric(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns true iff the argument is a primitive 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.

isPrimitive(TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns true iff the argument is a primitive type.

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

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.

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 given VariableElement.

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(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

isSuperCall(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Checks if the method invocation is a call to super.

isThisCall(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

isTreeInStaticScope(TreePath) - Static method in class org.checkerframework.javacutil.TreeUtils

Returns whether or not 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(Element) - Static method in class org.checkerframework.javacutil.ElementUtils

isTypeDeclaration(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

Determine whether the given tree represents a declaration of a type (including type parameters).

isTypeTree(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

Is the given tree a type instantiation?

isUseOfElement(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils

Determine whether the given ExpressionTree has an underlying element.

isWindows() - Static method in class org.checkerframework.javacutil.PluginUtil

J

JAVAC_PATH_OPT - Static variable in class org.checkerframework.javacutil.PluginUtil

Option name for specifying an alternative javac.jar location.

javacTypes - Variable in class org.checkerframework.javacutil.trees.TreeBuilder

JDK_PATH_OPT - Static variable in class org.checkerframework.javacutil.PluginUtil

Option name for specifying an alternative jdk.jar location.

join(String, T[]) - Static method in class org.checkerframework.javacutil.PluginUtil

join(String, Iterable<?>) - Static method in class org.checkerframework.javacutil.PluginUtil

K

kindToTag(Tree.Kind) - Method in class org.checkerframework.javacutil.trees.TreeBuilder

Map public AST Tree.Kinds to internal javac JCTree.Tags.

L

leastUpperBound(TypeMirror, TypeMirror, ProcessingEnvironment) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns the least upper bound of two TypeMirrors, ignoring any annotations on the types.

M

maker - Variable in class org.checkerframework.javacutil.trees.TreeBuilder

matchesElement(ExecutableElement, String, Class<?>...) - Static method in class org.checkerframework.javacutil.ElementUtils

Check that a method Element matches a signature.

methodName(MethodInvocationTree) - Static method in class org.checkerframework.javacutil.TreeUtils

methodParameterTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

methodReceiverTAPosition(int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

methodReturnTAPosition(int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

methodThrowsTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

methodTypeParameterBoundTAPosition(int, int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

methodTypeParameterTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

modelTypes - Variable in class org.checkerframework.javacutil.trees.TreeBuilder

N

names - Variable in class org.checkerframework.javacutil.trees.TreeBuilder

O

of(V1, V2) - Static method in class org.checkerframework.javacutil.Pair

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

Simple pair class for multiple returns.

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

pathTillClass(TreePath) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets path to the first enclosing class tree, where class is defined by the classTreeKinds method.

pathTillOfKind(TreePath, Tree.Kind) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets path to the first enclosing tree of the specified kind.

pathTillOfKind(TreePath, Set<Tree.Kind>) - Static method in class org.checkerframework.javacutil.TreeUtils

Gets path to the first enclosing tree with any one of the specified kinds.

PluginUtil - Class in org.checkerframework.javacutil

This file contains basic utility functions that should be reused to create a command-line call to CheckerMain.

PluginUtil() - Constructor for class org.checkerframework.javacutil.PluginUtil

PluginUtil.CheckerProp - Enum in org.checkerframework.javacutil

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.checkerframework.javacutil.AbstractTypeProcessor

The use of this method is obsolete in type processors.

R

readFile(File) - Static method in class org.checkerframework.javacutil.PluginUtil

Return a list of Strings, one per line of the file.

Resolver - Class in org.checkerframework.javacutil

A Utility class to find symbols corresponding to string references.

Resolver(ProcessingEnvironment) - Constructor for class org.checkerframework.javacutil.Resolver

S

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).

second - Variable in class org.checkerframework.javacutil.Pair

setDeclaration(VariableTree) - Method in class org.checkerframework.javacutil.trees.DetachedVarSymbol

Set the declaration tree for the variable.

setValue(CharSequence, AnnotationMirror) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, List<? extends Object>) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Object[]) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Boolean) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Character) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Double) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Float) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Integer) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Long) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Short) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, String) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, TypeMirror) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Class<?>) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Enum<?>) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, VariableElement) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, Enum<?>[]) - Method in class org.checkerframework.javacutil.AnnotationBuilder

setValue(CharSequence, VariableElement[]) - Method in class org.checkerframework.javacutil.AnnotationBuilder

skipParens(ExpressionTree) - Static method in class org.checkerframework.javacutil.TreeUtils

If the given tree is a parenthesized tree, it returns the enclosed non-parenthesized tree.

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.

symtab - Variable in class org.checkerframework.javacutil.trees.TreeBuilder

T

toFiles(List<String>) - Static method in class org.checkerframework.javacutil.PluginUtil

toJavaOpts(List<String>) - Static method in class org.checkerframework.javacutil.PluginUtil

toString() - Method in class org.checkerframework.javacutil.Pair

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

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

TreeUtils - Class in org.checkerframework.javacutil

A utility class made for helping to analyze a given Tree.

TypeAnnotationUtils - Class in org.checkerframework.javacutil

A collection of helper methods related to type annotation handling.

typeFromClass(Class<?>, Types, Elements) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns the TypeMirror for a given Class.

typeOf(Tree) - Static method in class org.checkerframework.javacutil.TreeUtils

typeParameterBoundTAPosition(int, int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

typeParameterTAPosition(int, int) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

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 and no error is reported.

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 TypeMirrors.

typeTreeKinds() - Static method in class org.checkerframework.javacutil.TreeUtils

U

unannotatedType(TypeMirror) - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

unknownTAPosition() - Static method in class org.checkerframework.javacutil.TypeAnnotationUtils

updateMappingToImmutableSet(Map<T, Set<AnnotationMirror>>, T, Set<AnnotationMirror>) - Static method in class org.checkerframework.javacutil.AnnotationUtils

See checkers.types.QualifierHierarchy#updateMappingToMutableSet(QualifierHierarchy, Map, Object, AnnotationMirror) (Not linked because it is in an independent project.

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 org.checkerframework.javacutil.PluginUtil.CheckerProp

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.checkerframework.javacutil.PluginUtil.CheckerProp

Returns an array containing the constants of this enum type, in the order they are declared.

W

widenedNumericType(TypeMirror, TypeMirror) - Static method in class org.checkerframework.javacutil.TypesUtils

Returns the widened numeric type for an arithmetic operation performed on a value of the left type and the right type.

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 This field is sometimes null, in that case this method will return null

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.

wrapArg(String) - Static method in class org.checkerframework.javacutil.PluginUtil

writeFile(File, List<String>) - Static method in class org.checkerframework.javacutil.PluginUtil

Write the strings to the file, one per line.

writeFofn(File, List<File>) - Static method in class org.checkerframework.javacutil.PluginUtil

Takes a list of files and writes it as a "File of file names" (i.e.

writeFofn(File, File...) - Static method in class org.checkerframework.javacutil.PluginUtil

Takes a list of files and writes it as a "File of file names" (i.e.

writeTmpCpFile(String, boolean, String) - Static method in class org.checkerframework.javacutil.PluginUtil

writeTmpFile(String, String, boolean, List<String>) - Static method in class org.checkerframework.javacutil.PluginUtil

Write the strings to a temporary file.

writeTmpFofn(String, String, boolean, List<File>) - Static method in class org.checkerframework.javacutil.PluginUtil

writeTmpSrcFofn(String, boolean, List<File>) - Static method in class org.checkerframework.javacutil.PluginUtil

A B C D E F G H I J K L M N O P R S T U V W