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

Modifier and Type	Method and Description
Elements	getElementUtils()
Types	getTypeUtils()
<R,P> R	visitUseSites(TypeElement type, UseSite.Visitor<R,P> visitor, P parameter) Visits the uses of the provided type.

Method Detail

getElementUtils

@Nonnull
Elements getElementUtils()

Returns:

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

See Also:

Elements

getTypeUtils

@Nonnull
Types getTypeUtils()

Returns:

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

See Also:

Types

visitUseSites

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

Visits the uses of the provided type. The visit will stop as soon as a non-null value is returned from the visitor, even if some use sites are left unvisited.

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