A C D E F G H I J K N O P S T U V

A

attachmentsFor(T, T, String...) - Static method in enum org.revapi.java.spi.Code

C

call() - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.Fn0

call(T) - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.Fn1

call(T1, T2) - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.Fn2

call(T1, T2, T3) - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.Fn3

call() - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.VoidFn0

call(T) - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.VoidFn1

call(T1, T2) - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.VoidFn2

call(T1, T2, T3) - Method in interface org.revapi.java.spi.IgnoreCompletionFailures.VoidFn3

Check - Interface in org.revapi.java.spi

An interface that java API checkers need to implement.

Check.Type - Enum in org.revapi.java.spi

CheckBase - Class in org.revapi.java.spi

A basic implementation of the Check interface.

CheckBase() - Constructor for class org.revapi.java.spi.CheckBase

CheckBase.ActiveElements<T extends JavaElement> - Class in org.revapi.java.spi

Represents the elements that have been pushed onto the active elements stack.

Code - Enum in org.revapi.java.spi

The is a list of all difference codes Revapi's Java extension can emit.

code() - Method in enum org.revapi.java.spi.Code

context - Variable in class org.revapi.java.spi.CheckBase.ActiveElements

createDifference(Code, LinkedHashMap<String, String>) - Method in class org.revapi.java.spi.CheckBase

createDifference(Locale) - Method in enum org.revapi.java.spi.Code

createDifference(Locale, LinkedHashMap<String, String>) - Method in enum org.revapi.java.spi.Code

createDifference(Locale, LinkedHashMap<String, String>, String...) - Method in enum org.revapi.java.spi.Code

createDifferenceWithExplicitParams(Code, LinkedHashMap<String, String>, String...) - Method in class org.revapi.java.spi.CheckBase

D

defaultMatchAction(Element, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

defaultMatchAction(TypeMirror, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

doEnd() - Method in class org.revapi.java.spi.CheckBase

doVisitAnnotation(JavaAnnotationElement, JavaAnnotationElement) - Method in class org.revapi.java.spi.CheckBase

doVisitClass(JavaTypeElement, JavaTypeElement) - Method in class org.revapi.java.spi.CheckBase

doVisitField(JavaFieldElement, JavaFieldElement) - Method in class org.revapi.java.spi.CheckBase

doVisitMethod(JavaMethodElement, JavaMethodElement) - Method in class org.revapi.java.spi.CheckBase

doVisitMethodParameter(JavaMethodParameterElement, JavaMethodParameterElement) - Method in class org.revapi.java.spi.CheckBase

E

ElementPairVisitor<R> - Class in org.revapi.java.spi

Can be used by various checks and problem transformations to work with two elements of the same type.

ElementPairVisitor() - Constructor for class org.revapi.java.spi.ElementPairVisitor

end(DeclaredType, P) - Method in interface org.revapi.java.spi.UseSite.Visitor

Called when all uses have been visited.

equals(Object) - Method in class org.revapi.java.spi.UseSite

extract(Archive) - Method in interface org.revapi.java.spi.JarExtractor

Tries to transform the data of the archive such that it looks like a simple jar file to the analyzer.

F

fillAllSuperInterfaces(Types, TypeMirror, List<TypeMirror>) - Static method in class org.revapi.java.spi.Util

fillAllSuperTypes(Types, TypeMirror, List<TypeMirror>) - Static method in class org.revapi.java.spi.Util

Similar to Util.getAllSuperTypes(javax.lang.model.util.Types, javax.lang.model.type.TypeMirror) but avoids instantiation of a new list.

findTypeByBinaryName(Elements, String) - Static method in class org.revapi.java.spi.Util

Tries to find a type element using the provided Elements helper given its binary name.

fromCode(String) - Static method in enum org.revapi.java.spi.Code

G

getAllSuperClasses(Types, TypeMirror) - Static method in class org.revapi.java.spi.Util

Returns all the super classes of given type.

getAllSuperInterfaces(Types, TypeMirror) - Static method in class org.revapi.java.spi.Util

getAllSuperTypes(Types, TypeMirror) - Static method in class org.revapi.java.spi.Util

Similar to Util.getAllSuperClasses(javax.lang.model.util.Types, javax.lang.model.type.TypeMirror) but returns all super types including implemented interfaces.

getAnalysisContext() - Method in class org.revapi.java.spi.CheckBase

getAnnotation() - Method in interface org.revapi.java.spi.JavaAnnotationElement

getChildren() - Method in interface org.revapi.java.spi.JavaElement

getDeclaringElement() - Method in interface org.revapi.java.spi.JavaFieldElement

getDeclaringElement() - Method in interface org.revapi.java.spi.JavaMethodElement

getDeclaringElement() - Method in interface org.revapi.java.spi.JavaMethodParameterElement

getDeclaringElement() - Method in interface org.revapi.java.spi.JavaModelElement

For an inherited method for example, this will return the element in the super type that declares this method.

getDeclaringElement() - Method in interface org.revapi.java.spi.JavaTypeElement

getElementUtils() - Method in interface org.revapi.java.spi.TypeEnvironment

getExtensionId() - Method in class org.revapi.java.spi.CheckBase

getIndex() - Method in interface org.revapi.java.spi.JavaMethodParameterElement

getInterest() - Method in interface org.revapi.java.spi.Check

Each check typically checks only a single type of java element - a method or an annotation - but may be interested in more.

getJSONSchema() - Method in class org.revapi.java.spi.CheckBase

getModelRepresentation() - Method in interface org.revapi.java.spi.JavaMethodElement

getModelRepresentation() - Method in interface org.revapi.java.spi.JavaModelElement

Note that this is distinctly different from JavaModelElement.getDeclaringElement().

getModelRepresentation() - Method in interface org.revapi.java.spi.JavaTypeElement

getNewTypeEnvironment() - Method in class org.revapi.java.spi.CheckBase

getOldTypeEnvironment() - Method in class org.revapi.java.spi.CheckBase

getParent() - Method in interface org.revapi.java.spi.JavaAnnotationElement

getParent() - Method in interface org.revapi.java.spi.JavaFieldElement

getParent() - Method in interface org.revapi.java.spi.JavaMethodElement

getParent() - Method in interface org.revapi.java.spi.JavaMethodParameterElement

getParent() - Method in interface org.revapi.java.spi.JavaModelElement

getSite() - Method in class org.revapi.java.spi.UseSite

getTypeEnvironment() - Method in interface org.revapi.java.spi.JavaElement

getTypeUtils() - Method in interface org.revapi.java.spi.TypeEnvironment

getUseSites() - Method in interface org.revapi.java.spi.JavaTypeElement

getUseType() - Method in class org.revapi.java.spi.UseSite

H

hashCode() - Method in class org.revapi.java.spi.UseSite

I

IgnoreCompletionFailures - Class in org.revapi.java.spi

A utility class to try to overcome the CompletionFailure exceptions thrown from the Java compiler.

IgnoreCompletionFailures.Fn0<R> - Interface in org.revapi.java.spi

IgnoreCompletionFailures.Fn1<R,T> - Interface in org.revapi.java.spi

IgnoreCompletionFailures.Fn2<R,T1,T2> - Interface in org.revapi.java.spi

IgnoreCompletionFailures.Fn3<R,T1,T2,T3> - Interface in org.revapi.java.spi

IgnoreCompletionFailures.VoidFn0 - Interface in org.revapi.java.spi

IgnoreCompletionFailures.VoidFn1<T> - Interface in org.revapi.java.spi

IgnoreCompletionFailures.VoidFn2<T1,T2> - Interface in org.revapi.java.spi

IgnoreCompletionFailures.VoidFn3<T1,T2,T3> - Interface in org.revapi.java.spi

in(IgnoreCompletionFailures.Fn0<R>) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

in(IgnoreCompletionFailures.Fn1<R, T>, T) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

in(IgnoreCompletionFailures.Fn2<R, T1, T2>, T1, T2) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

in(IgnoreCompletionFailures.Fn3<R, T1, T2, T3>, T1, T2, T3) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

initialize(AnalysisContext) - Method in class org.revapi.java.spi.CheckBase

inVoid(IgnoreCompletionFailures.VoidFn0) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

inVoid(IgnoreCompletionFailures.VoidFn1<T>, T) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

inVoid(IgnoreCompletionFailures.VoidFn2<T1, T2>, T1, T2) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

inVoid(IgnoreCompletionFailures.VoidFn3<T1, T2, T3>, T1, T2, T3) - Static method in class org.revapi.java.spi.IgnoreCompletionFailures

isAccessible(JavaModelElement) - Method in class org.revapi.java.spi.CheckBase

This method checks that the provided element and all its parent elements are accessible (public or protected).

isBothAccessible(JavaModelElement, JavaModelElement) - Method in class org.revapi.java.spi.CheckBase

Checks whether both provided elements are public or protected.

isBothPrivate(JavaModelElement, JavaModelElement) - Method in class org.revapi.java.spi.CheckBase

Checks whether both provided elements are (package) private.

isDescendingOnNonExisting() - Method in interface org.revapi.java.spi.Check

When the analyzer encounters an element that doesn't have a matching counterpart in the other version of the API, by default, the analysis doesn't descend into the children of the existing element.

isDescendingOnNonExisting() - Method in class org.revapi.java.spi.CheckBase

The default implementation returns false, because that is the right decision most of the time.

isEqual(AnnotationValue, AnnotationValue) - Static method in class org.revapi.java.spi.Util

isExplicitlyExcluded(Element) - Method in interface org.revapi.java.spi.TypeEnvironment

This returns true for elements that are excluded by the means of configuration.

isExplicitlyIncluded(Element) - Method in interface org.revapi.java.spi.TypeEnvironment

This returns true for elements that are included by the means of configuration.

isInAPI() - Method in interface org.revapi.java.spi.JavaTypeElement

isInApiThroughUse() - Method in interface org.revapi.java.spi.JavaTypeElement

isInherited() - Method in interface org.revapi.java.spi.JavaModelElement

Each JavaTypeElement contains as its children not only the elements that are declared on the type but also elements that it inherits from its super types (with type parameters "instantiated" according to the actual type).

isMissing(Element) - Method in class org.revapi.java.spi.CheckBase

The element is deemed missing if its type kind (TypeMirror.getKind()) is TypeKind.ERROR.

isMovingToApi() - Method in enum org.revapi.java.spi.UseSite.Type

isSameType(TypeMirror, TypeMirror) - Static method in class org.revapi.java.spi.Util

To be used to compare types from different compilations (which are not comparable by standard means in Types).

isSubtype(TypeMirror, List<? extends TypeMirror>, Types) - Static method in class org.revapi.java.spi.Util

Checks whether given type is a sub type or is equal to one of the provided types.

J

JarExtractor - Interface in org.revapi.java.spi

The role of the jar extractor is to find class files in an archive that should be considered for API analysis.

JavaAnnotationElement - Interface in org.revapi.java.spi

Elements in the element forest that correspond to a Java annotation will implement this interface.

JavaElement - Interface in org.revapi.java.spi

Basic interface that all Revapi elements modelling the Java AST satisfy.

JavaFieldElement - Interface in org.revapi.java.spi

Elements in the element forest that represent Java fields, will implement this interface.

JavaMethodElement - Interface in org.revapi.java.spi

Elements in the element forest that represent Java methods, will implement this interface.

JavaMethodParameterElement - Interface in org.revapi.java.spi

Elements in the element forest that represent Java method parameters, will implement this interface.

JavaModelElement - Interface in org.revapi.java.spi

All elements corresponding to various Java language model (apart from annotations (see JavaAnnotationElement)), i.e.

JavaTypeElement - Interface in org.revapi.java.spi

Elements in the element forest that represent Java types, will implement this interface.

K

keyAnnotationAttributesByName(Map<? extends ExecutableElement, ? extends AnnotationValue>) - Static method in class org.revapi.java.spi.Util

Extracts the names of the attributes from the executable elements that represents them in the given map and returns a map keyed by those names.

N

newElement - Variable in class org.revapi.java.spi.CheckBase.ActiveElements

O

oldElement - Variable in class org.revapi.java.spi.CheckBase.ActiveElements

org.revapi.java.spi - package org.revapi.java.spi

P

peekLastActive() - Method in class org.revapi.java.spi.CheckBase

popIfActive() - Method in class org.revapi.java.spi.CheckBase

Pops the top of the stack of active elements if the current position in the call stack corresponds to the one that pushed the active elements.

previous - Variable in class org.revapi.java.spi.CheckBase.ActiveElements

pushActive(T, T, Object...) - Method in class org.revapi.java.spi.CheckBase

If called in one of the doVisit*() methods, this method will push the elements along with some contextual data onto an internal stack.

S

setNewTypeEnvironment(TypeEnvironment) - Method in interface org.revapi.java.spi.Check

The environment containing the new version of the classes.

setNewTypeEnvironment(TypeEnvironment) - Method in class org.revapi.java.spi.CheckBase

setOldTypeEnvironment(TypeEnvironment) - Method in interface org.revapi.java.spi.Check

The environment containing the old version of the classes.

setOldTypeEnvironment(TypeEnvironment) - Method in class org.revapi.java.spi.CheckBase

T

toHumanReadableString(AnnotatedConstruct) - Static method in class org.revapi.java.spi.Util

Constructs a human readable representation of the supplied element or type mirror.

toHumanReadableString(AnnotationValue) - Static method in class org.revapi.java.spi.Util

toHumanReadableString(AnnotationMirror) - Static method in class org.revapi.java.spi.Util

toString() - Method in class org.revapi.java.spi.UseSite

toUniqueString(TypeMirror) - Static method in class org.revapi.java.spi.Util

Represents the type mirror as a string in such a way that it can be used for equality comparisons.

toUniqueString(AnnotationValue) - Static method in class org.revapi.java.spi.Util

TypeEnvironment - Interface in org.revapi.java.spi

This interface mimics (to an extent) the ProcessingEnvironment and serves the same purpose.

TypeMirrorPairVisitor<R> - Class in org.revapi.java.spi

Similar to ElementPairVisitor but provides a visitor to visit two type mirrors of the same type.

TypeMirrorPairVisitor() - Constructor for class org.revapi.java.spi.TypeMirrorPairVisitor

U

unmatchedAction(Element, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

unmatchedAction(TypeMirror, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

UseSite - Class in org.revapi.java.spi

UseSite(UseSite.Type, JavaElement) - Constructor for class org.revapi.java.spi.UseSite

UseSite.Type - Enum in org.revapi.java.spi

The way the used class is used by the use site.

UseSite.Visitor<R,P> - Interface in org.revapi.java.spi

A visitor of the use site.

Util - Class in org.revapi.java.spi

A random assortment of methods to help with implementing the Java API checks made public so that extenders don't have to reinvent the wheel.

V

valueOf(String) - Static method in enum org.revapi.java.spi.Check.Type

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

valueOf(String) - Static method in enum org.revapi.java.spi.Code

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

valueOf(String) - Static method in enum org.revapi.java.spi.UseSite.Type

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

values() - Static method in enum org.revapi.java.spi.Check.Type

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

values() - Static method in enum org.revapi.java.spi.Code

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

values() - Static method in enum org.revapi.java.spi.UseSite.Type

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

visit(DeclaredType, UseSite, P) - Method in interface org.revapi.java.spi.UseSite.Visitor

Visits the use site.

visitAnnotation(JavaAnnotationElement, JavaAnnotationElement) - Method in interface org.revapi.java.spi.Check

Visiting annotation is slightly different, because it is not followed by the standard Check.visitEnd() call.

visitAnnotation(JavaAnnotationElement, JavaAnnotationElement) - Method in class org.revapi.java.spi.CheckBase

Please override the CheckBase.doVisitAnnotation(JavaAnnotationElement, JavaAnnotationElement) instead.

visitArray(ArrayType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitArray(ArrayType, ArrayType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitClass(JavaTypeElement, JavaTypeElement) - Method in interface org.revapi.java.spi.Check

visitClass(JavaTypeElement, JavaTypeElement) - Method in class org.revapi.java.spi.CheckBase

Please override the CheckBase.doVisitClass(JavaTypeElement, JavaTypeElement)

visitDeclared(DeclaredType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitDeclared(DeclaredType, DeclaredType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitEnd() - Method in interface org.revapi.java.spi.Check

Each of the other visit* calls is followed by a corresponding call to this method in a stack-like manner.

visitEnd() - Method in class org.revapi.java.spi.CheckBase

Please override the CheckBase.doEnd() method instead.

visitError(ErrorType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitError(ErrorType, ErrorType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitExecutable(ExecutableElement, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

visitExecutable(ExecutableElement, ExecutableElement) - Method in class org.revapi.java.spi.ElementPairVisitor

visitExecutable(ExecutableType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitExecutable(ExecutableType, ExecutableType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitField(JavaFieldElement, JavaFieldElement) - Method in interface org.revapi.java.spi.Check

visitField(JavaFieldElement, JavaFieldElement) - Method in class org.revapi.java.spi.CheckBase

Please override the CheckBase.doVisitField(JavaFieldElement, JavaFieldElement) instead.

visitIntersection(IntersectionType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitIntersection(IntersectionType, IntersectionType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitMethod(JavaMethodElement, JavaMethodElement) - Method in interface org.revapi.java.spi.Check

visitMethod(JavaMethodElement, JavaMethodElement) - Method in class org.revapi.java.spi.CheckBase

Please override the CheckBase.doVisitMethod(JavaMethodElement, JavaMethodElement) instead.

visitMethodParameter(JavaMethodParameterElement, JavaMethodParameterElement) - Method in interface org.revapi.java.spi.Check

visitMethodParameter(JavaMethodParameterElement, JavaMethodParameterElement) - Method in class org.revapi.java.spi.CheckBase

visitNoType(NoType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitNoType(NoType, NoType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitNull(NullType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitNull(NullType, NullType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitPackage(PackageElement, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

visitPackage(PackageElement, PackageElement) - Method in class org.revapi.java.spi.ElementPairVisitor

visitPrimitive(PrimitiveType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitPrimitive(PrimitiveType, PrimitiveType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitType(TypeElement, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

visitType(TypeElement, TypeElement) - Method in class org.revapi.java.spi.ElementPairVisitor

visitTypeParameter(TypeParameterElement, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

visitTypeParameter(TypeParameterElement, TypeParameterElement) - Method in class org.revapi.java.spi.ElementPairVisitor

visitTypeVariable(TypeVariable, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitTypeVariable(TypeVariable, TypeVariable) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitUnion(UnionType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitUnion(UnionType, UnionType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitUnknown(Element, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

visitUnknown(TypeMirror, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitUseSites(UseSite.Visitor<R, P>, P) - Method in interface org.revapi.java.spi.JavaTypeElement

Visits the uses of the provided type.

visitVariable(VariableElement, Element) - Method in class org.revapi.java.spi.ElementPairVisitor

visitVariable(VariableElement, VariableElement) - Method in class org.revapi.java.spi.ElementPairVisitor

visitWildcard(WildcardType, TypeMirror) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

visitWildcard(WildcardType, WildcardType) - Method in class org.revapi.java.spi.TypeMirrorPairVisitor

A C D E F G H I J K N O P S T U V