org.revapi.java.spi

Class CheckBase

java.lang.Object

org.revapi.java.spi.CheckBase

All Implemented Interfaces:

org.revapi.configuration.Configurable, Check

public abstract class CheckBase
extends Object
implements Check

A basic implementation of the Check interface. This class easies the matching of the visit*() methods and their corresponding visitEnd() by keeping track of the "depth" individual calls (see the recursive nature of the call order).

This class also contains a couple of utility methods for checking the accessibility of elements, etc.

Since:

0.1

Author:

Lukas Krejci

See Also:

pushActive(javax.lang.model.element.Element, javax.lang.model.element.Element, Object...), popIfActive()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CheckBase.ActiveElements<T extends Element> Represents the elements that have been pushed onto the active elements stack.

Nested classes/interfaces inherited from interface org.revapi.java.spi.Check

Check.Type

Constructor Summary

Constructors

Constructor and Description
CheckBase()

Method Summary

Modifier and Type	Method and Description
protected org.revapi.Difference	createDifference(Code code, Object... params)
protected org.revapi.Difference	createDifference(Code code, Object[] params, Object... attachments)
protected List<org.revapi.Difference>	doEnd()
protected List<org.revapi.Difference>	doVisitAnnotation(AnnotationMirror oldAnnotation, AnnotationMirror newAnnotation)
protected void	doVisitClass(TypeElement oldType, TypeElement newType)
protected void	doVisitField(VariableElement oldField, VariableElement newField)
protected void	doVisitMethod(ExecutableElement oldMethod, ExecutableElement newMethod)
protected void	doVisitMethodParameter(VariableElement oldParameter, VariableElement newParameter)
org.revapi.AnalysisContext	getAnalysisContext()
String[]	getConfigurationRootPaths()
Reader	getJSONSchema(String configurationRootPath)
TypeEnvironment	getNewTypeEnvironment()
TypeEnvironment	getOldTypeEnvironment()
void	initialize(org.revapi.AnalysisContext analysisContext)
boolean	isAccessible(Element e, TypeEnvironment env)
boolean	isBothAccessible(Element a, TypeEnvironment envA, Element b, TypeEnvironment envB) Checks whether both provided elements are public or protected.
boolean	isBothPrivate(Element a, TypeEnvironment envA, Element b, TypeEnvironment envB) Checks whether both provided elements are (package) private.
boolean	isMissing(Element e) The element is deemed missing if its type kind (TypeMirror.getKind()) is TypeKind.ERROR.
boolean	isPubliclyUsedAs(TypeElement type, TypeEnvironment env, Collection<UseSite.Type> uses) Checks if the type is publicly used as any of the provided use types.
boolean	isSkipUseTracking() This base class reads the configuration during the initialization and if the "revapi.java.deepUseChainAnalysis" is set to true, it does expensive checks for usage of private classes in a public manner.
protected <T extends Element> CheckBase.ActiveElements<T>	popIfActive() 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.
protected <T extends Element> void	pushActive(T oldElement, T newElement, Object... context) If called in one of the doVisit*() methods, this method will push the elements along with some contextual data onto an internal stack.
void	setNewTypeEnvironment(TypeEnvironment env) The environment containing the new version of the classes.
void	setOldTypeEnvironment(TypeEnvironment env) The environment containing the old version of the classes.
protected void	setSkipUseTracking(boolean value) By default, this value is read from the configuration during the initialize(AnalysisContext) call.
List<org.revapi.Difference>	visitAnnotation(AnnotationMirror oldAnnotation, AnnotationMirror newAnnotation) Please override the doVisitAnnotation(javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationMirror) instead.
void	visitClass(TypeElement oldType, TypeElement newType) Please override the doVisitClass(javax.lang.model.element.TypeElement, javax.lang.model.element.TypeElement) instead.
List<org.revapi.Difference>	visitEnd() Please override the doEnd() method instead.
void	visitField(VariableElement oldField, VariableElement newField) Please override the doVisitField(javax.lang.model.element.VariableElement, javax.lang.model.element.VariableElement) instead.
void	visitMethod(ExecutableElement oldMethod, ExecutableElement newMethod) Please override the doVisitMethod(javax.lang.model.element.ExecutableElement, javax.lang.model.element.ExecutableElement) instead.
void	visitMethodParameter(VariableElement oldParameter, VariableElement newParameter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.revapi.java.spi.Check

getInterest

Constructor Detail

CheckBase

public CheckBase()

Method Detail

isBothPrivate

public boolean isBothPrivate(@Nullable
                             Element a,
                             TypeEnvironment envA,
                             @Nullable
                             Element b,
                             TypeEnvironment envB)

Checks whether both provided elements are (package) private. If one of them is null, the fact cannot be determined and therefore this method would return false.

Parameters:

a - first element

envA - the type environment of the first element

b - second element

envB - the type environment of the second element

Returns:

true if both elements are not null and are private or package private

isBothAccessible

public boolean isBothAccessible(@Nullable
                                Element a,
                                @Nonnull
                                TypeEnvironment envA,
                                @Nullable
                                Element b,
                                @Nonnull
                                TypeEnvironment envB)

Checks whether both provided elements are public or protected. If one at least one of them is null, the method returns false, because the accessibility cannot be truthfully detected in that case.

Parameters:

a - first element

envA - the type environment of the first element

b - second element

envB - the type environment of the second element

Returns:

true if both elements are not null and accessible (i.e. public or protected)

isAccessible

public boolean isAccessible(@Nonnull
                            Element e,
                            @Nonnull
                            TypeEnvironment env)

Parameters:

e - the element to check

env - the type environment of the element

Returns:

true if the provided element is public or protected, false otherwise.

isMissing

public boolean isMissing(@Nonnull
                         Element e)

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

Parameters:

e - the element

Returns:

true if the element is missing, false otherwise

isPubliclyUsedAs

public boolean isPubliclyUsedAs(@Nonnull
                                TypeElement type,
                                TypeEnvironment env,
                                Collection<UseSite.Type> uses)

Checks if the type is publicly used as any of the provided use types.

Parameters:

type - the type

env - the environment in which the type exists

uses - the use types to check for

Returns:

true if the type is used at least once as any of the provided use types, false otherwise

isSkipUseTracking

public boolean isSkipUseTracking()

This base class reads the configuration during the initialization and if the "revapi.java.deepUseChainAnalysis" is set to true, it does expensive checks for usage of private classes in a public manner.

Returns:

true if use tracking is not used in isAccessible(Element, TypeEnvironment) method, false if it is

setSkipUseTracking

protected void setSkipUseTracking(boolean value)

By default, this value is read from the configuration during the initialize(AnalysisContext) call. If you need to override that value for some reason, use this method.

Parameters:

value - the new value of the skipUseTracking property

createDifference

@Nonnull
protected org.revapi.Difference createDifference(@Nonnull
                                                          Code code,
                                                          Object... params)

createDifference

@Nonnull
protected org.revapi.Difference createDifference(@Nonnull
                                                          Code code,
                                                          @Nullable
                                                          Object[] params,
                                                          Object... attachments)

getOldTypeEnvironment

@Nonnull
public TypeEnvironment getOldTypeEnvironment()

getNewTypeEnvironment

@Nonnull
public TypeEnvironment getNewTypeEnvironment()

getAnalysisContext

@Nonnull
public org.revapi.AnalysisContext getAnalysisContext()

getConfigurationRootPaths

@Nullable
public String[] getConfigurationRootPaths()

Specified by:

getConfigurationRootPaths in interface org.revapi.configuration.Configurable

getJSONSchema

@Nullable
public Reader getJSONSchema(@Nonnull
                                      String configurationRootPath)

Specified by:

getJSONSchema in interface org.revapi.configuration.Configurable

initialize

public void initialize(@Nonnull
                       org.revapi.AnalysisContext analysisContext)

Specified by:

initialize in interface org.revapi.configuration.Configurable

setOldTypeEnvironment

public void setOldTypeEnvironment(@Nonnull
                                  TypeEnvironment env)

Description copied from interface: Check

The environment containing the old version of the classes. This can be used to reason about the classes when doing the checks.

Called once after the check has been instantiated.

Specified by:

setOldTypeEnvironment in interface Check

Parameters:

env - the environment to obtain the helper objects using which one can navigate and examine types

setNewTypeEnvironment

public void setNewTypeEnvironment(@Nonnull
                                  TypeEnvironment env)

Description copied from interface: Check

The environment containing the new version of the classes. This can be used to reason about the classes when doing the checks.

Called once after the check has been instantiated.

Specified by:

setNewTypeEnvironment in interface Check

Parameters:

env - the environment to obtain the helper objects using which one can navigate and examine types

visitEnd

@Nullable
public final List<org.revapi.Difference> visitEnd()

Please override the doEnd() method instead.

Specified by:

visitEnd in interface Check

Returns:

the list of found differences between corresponding elements or null if no differences found (null is considered equivalent to returning an empty collection).

See Also:

Check.visitEnd()

doEnd

@Nullable
protected List<org.revapi.Difference> doEnd()

visitClass

public final void visitClass(@Nullable
                             TypeElement oldType,
                             @Nullable
                             TypeElement newType)

Please override the doVisitClass(javax.lang.model.element.TypeElement, javax.lang.model.element.TypeElement) instead.

Specified by:

visitClass in interface Check

See Also:

Check.visitClass(javax.lang.model.element.TypeElement, javax.lang.model.element.TypeElement)

doVisitClass

protected void doVisitClass(@Nullable
                            TypeElement oldType,
                            @Nullable
                            TypeElement newType)

visitMethod

public final void visitMethod(@Nullable
                              ExecutableElement oldMethod,
                              @Nullable
                              ExecutableElement newMethod)

Please override the doVisitMethod(javax.lang.model.element.ExecutableElement, javax.lang.model.element.ExecutableElement) instead.

Specified by:

visitMethod in interface Check

See Also:

Check.visitMethod(javax.lang.model.element.ExecutableElement, javax.lang.model.element.ExecutableElement)

doVisitMethod

protected void doVisitMethod(@Nullable
                             ExecutableElement oldMethod,
                             @Nullable
                             ExecutableElement newMethod)

visitMethodParameter

public final void visitMethodParameter(@Nullable
                                       VariableElement oldParameter,
                                       @Nullable
                                       VariableElement newParameter)

Specified by:

visitMethodParameter in interface Check

doVisitMethodParameter

protected void doVisitMethodParameter(@Nullable
                                      VariableElement oldParameter,
                                      @Nullable
                                      VariableElement newParameter)

visitField

public final void visitField(@Nullable
                             VariableElement oldField,
                             @Nullable
                             VariableElement newField)

Please override the doVisitField(javax.lang.model.element.VariableElement, javax.lang.model.element.VariableElement) instead.

Specified by:

visitField in interface Check

See Also:

Check.visitField(javax.lang.model.element.VariableElement, javax.lang.model.element.VariableElement)

doVisitField

protected void doVisitField(@Nullable
                            VariableElement oldField,
                            @Nullable
                            VariableElement newField)

visitAnnotation

@Nullable
public final List<org.revapi.Difference> visitAnnotation(@Nullable
                                                                   AnnotationMirror oldAnnotation,
                                                                   @Nullable
                                                                   AnnotationMirror newAnnotation)

Please override the doVisitAnnotation(javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationMirror) instead.

Specified by:

visitAnnotation in interface Check

Parameters:

oldAnnotation - the annotation in the old API

newAnnotation - the annotation in the new API

Returns:

the list of differences between the two annotations

See Also:

Check.visitAnnotation(javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationMirror)

doVisitAnnotation

@Nullable
protected List<org.revapi.Difference> doVisitAnnotation(@Nullable
                                                                  AnnotationMirror oldAnnotation,
                                                                  @Nullable
                                                                  AnnotationMirror newAnnotation)

pushActive

protected final <T extends Element> void pushActive(@Nullable
                                                    T oldElement,
                                                    @Nullable
                                                    T newElement,
                                                    Object... context)

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

You can then retrieve the contents on the top of the stack in your doEnd() override by calling the popIfActive() method.

Type Parameters:

T - the type of the elements

Parameters:

oldElement - the old API element

newElement - the new API element

context - optional contextual data

popIfActive

@Nullable
protected <T extends Element> CheckBase.ActiveElements<T> popIfActive()

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.

This method does not do any type checks, so take care to retrieve the elements with the same types used to push to them onto the stack.

Type Parameters:

T - the type of the elements

Returns:

the active elements or null if the current call stack did not push any active elements onto the stack