org.revapi.java.spi

Interface TypeEnvironment

public interface TypeEnvironment

This interface mimics (to an extent) the ProcessingEnvironment and serves the same purpose. To give a context to the API checking classes.

Since:

0.1

Author:

Lukas Krejci

Method Summary

Methods

Modifier and Type	Method and Description
Elements	getElementUtils() The instance of the utility class to examine the elements of the API (types, methods, etc.)
Types	getTypeUtils() The instance of the utility class to examine the types in the API.
Set<UseSite>	getUseSites(TypeElement type) Returns the known use sites of the given type.
boolean	isExplicitPartOfAPI(TypeElement type) Determines whether given class is explicitly part of the API being checked.
<R,P> R	visitUseSites(TypeElement type, UseSite.Visitor<R,P> visitor, P parameter) Visits all uses of the provided type and recursively all uses of the types of the use sites.

Method Detail

getElementUtils

@Nonnull
Elements getElementUtils()

The instance of the utility class to examine the elements of the API (types, methods, etc.)

See Also:

Elements

getTypeUtils

@Nonnull
Types getTypeUtils()

The instance of the utility class to examine the types in the API.

See Also:

Types

isExplicitPartOfAPI

boolean isExplicitPartOfAPI(@Nonnull
                          TypeElement type)

Determines whether given class is explicitly part of the API being checked. This might return false for inner classes or (package) private classes.

The model still contains the classes that are not explicitly part of the API because there still might be checks on them that might be relevant, like annotation or visibility checks.

Parameters:

type - the type to check

Returns:

true if the type is explicitly part of the API, false if it is not

getUseSites

@Nonnull
Set<UseSite> getUseSites(@Nonnull
                               TypeElement type)

Returns the known use sites of the given type.

Parameters:

type - the type

Returns:

the use sites found during the analysis of archives

visitUseSites

@Nullable
<R,P> R visitUseSites(@Nonnull
                             TypeElement type,
                             @Nonnull
                             UseSite.Visitor<R,P> visitor,
                             @Nullable
                             P parameter)

Visits all uses of the provided type and recursively all uses of the types of the use sites.

I.e. when the provided type is used as a return type of a method, the visitor will also visit the type that defines the method and all its uses, recursively.

Type Parameters:

R - the return type (use Void for no return type)

P - the type of the parameter (use Void for no particular type)

Parameters:

type - the type to visit uses of

visitor - the visitor

parameter - the parameter to supply to the visitor

Returns:

the value returned by the visitor