org.revapi.java.spi

Interface JavaTypeElement

All Superinterfaces:

Comparable<org.revapi.Element>, org.revapi.Element, JavaElement, JavaModelElement

public interface JavaTypeElement
extends JavaModelElement

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

Since:

0.1

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
TypeElement	getDeclaringElement() For an inherited method for example, this will return the element in the super type that declares this method.
DeclaredType	getModelRepresentation() Note that this is distinctly different from JavaModelElement.getDeclaringElement().
Set<UseSite>	getUseSites()
boolean	isInAPI()
boolean	isInApiThroughUse()
default <R,P> R	visitUseSites(UseSite.Visitor<R,P> visitor, P parameter) Visits the uses of the provided type.

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

getParent, isInherited

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

getChildren, getTypeEnvironment

Methods inherited from interface org.revapi.Element

as, getApi, getArchive, getFullHumanReadableString, iterateOverChildren, searchChildren, searchChildren, setParent

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getModelRepresentation

DeclaredType getModelRepresentation()

Description copied from interface: JavaModelElement

Note that this is distinctly different from JavaModelElement.getDeclaringElement(). This method returns a type mirror describing an element on its position in the type hierarchy. I.e. if an inherited method with type parameters resolved according to the class it is inherited "to".

Specified by:

getModelRepresentation in interface JavaModelElement

Returns:

the representation of this java element at its position in the type hierarchy

getDeclaringElement

TypeElement getDeclaringElement()

Description copied from interface: JavaModelElement

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

Specified by:

getDeclaringElement in interface JavaModelElement

Returns:

The element that represents the declaration this model element.

getUseSites

Set<UseSite> getUseSites()

Returns:

the set of "places" where this type element is used

visitUseSites

default <R,P> R visitUseSites(UseSite.Visitor<R,P> visitor,
                              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:

visitor - the visitor

parameter - the parameter to supply to the visitor

Returns:

the value returned by the visitor

isInAPI

boolean isInAPI()

Returns:

true if this type was found to be a part of the API, false otherwise

isInApiThroughUse

boolean isInApiThroughUse()

Returns:

true, if the class is not accessible in and of itself but is dragged into the API by a significant use.