org.revapi.java.model

Class TypeElement

java.lang.Object

org.revapi.simple.SimpleElement

org.revapi.java.model.JavaElementBase<TypeElement,DeclaredType>

org.revapi.java.model.TypeElement

All Implemented Interfaces:

Comparable<org.revapi.Element>, org.revapi.Element, org.revapi.java.spi.JavaElement, org.revapi.java.spi.JavaModelElement, org.revapi.java.spi.JavaTypeElement

Direct Known Subclasses:

MissingClassElement

public class TypeElement
extends JavaElementBase<TypeElement,DeclaredType>
implements org.revapi.java.spi.JavaTypeElement

Since:

0.1

Author:

Lukas Krejci

Field Summary

Fields inherited from class org.revapi.java.model.JavaElementBase

element, environment, representation

Constructor Summary

Constructors

Constructor and Description
TypeElement(ProbingEnvironment env, org.revapi.Archive archive, String binaryName, String canonicalName) This is a helper constructor used only during probing the class files.
TypeElement(ProbingEnvironment env, org.revapi.Archive archive, TypeElement element, DeclaredType type) This constructor is used under "normal working conditions" when the probing environment already has the compilation infrastructure available (which is assumed since otherwise it would not be possible to obtain instances of the javax.lang.model.element.TypeElement interface).

Method Summary

Modifier and Type	Method and Description
int	compareTo(org.revapi.Element o)
protected String	createComparableSignature()
protected String	createFullHumanReadableString()
String	getBinaryName()
String	getCanonicalName()
protected String	getHumanReadableElementType()
Set<org.revapi.java.spi.UseSite>	getUseSites()
boolean	isInAPI()
boolean	isInApiThroughUse()
void	setInApi(boolean inApi)
void	setInApiThroughUse(boolean inApiThroughUse)
void	setRawUseSites(Set<ClassPathUseSite> rawUseSites)

Methods inherited from class org.revapi.java.model.JavaElementBase

equals, getApi, getArchive, getChildren, getComparableSignature, getDeclaringElement, getFullHumanReadableString, getModelRepresentation, getParent, getTypeEnvironment, hashCode, isInherited, setInherited, setParent, toString

Methods inherited from class org.revapi.simple.SimpleElement

getDirectChildrenOfType, iterateOverChildren, newChildrenInstance, searchChildren, searchChildren

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getDeclaringElement, getModelRepresentation, visitUseSites

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

getParent, isInherited

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

getTypeEnvironment

Methods inherited from interface org.revapi.Element

getApi, getArchive, getChildren, getFullHumanReadableString, iterateOverChildren, searchChildren, searchChildren, setParent

Constructor Detail

TypeElement

public TypeElement(ProbingEnvironment env,
                   org.revapi.Archive archive,
                   String binaryName,
                   String canonicalName)

This is a helper constructor used only during probing the class files. This is to ensure that we have a "bare bones" type element available even before we have functioning compilation infrastructure in the environment.

Parameters:

env - probing environment

binaryName - the binary name of the class

canonicalName - the canonical name of the class

TypeElement

public TypeElement(ProbingEnvironment env,
                   org.revapi.Archive archive,
                   TypeElement element,
                   DeclaredType type)

This constructor is used under "normal working conditions" when the probing environment already has the compilation infrastructure available (which is assumed since otherwise it would not be possible to obtain instances of the javax.lang.model.element.TypeElement interface).

Parameters:

env - the probing environment

element - the model element to be represented

Method Detail

getHumanReadableElementType

@Nonnull
protected String getHumanReadableElementType()

Specified by:

getHumanReadableElementType in class JavaElementBase<TypeElement,DeclaredType>

getBinaryName

public String getBinaryName()

getCanonicalName

public String getCanonicalName()

isInAPI

public boolean isInAPI()

Specified by:

isInAPI in interface org.revapi.java.spi.JavaTypeElement

isInApiThroughUse

public boolean isInApiThroughUse()

Specified by:

isInApiThroughUse in interface org.revapi.java.spi.JavaTypeElement

getUseSites

public Set<org.revapi.java.spi.UseSite> getUseSites()

Specified by:

getUseSites in interface org.revapi.java.spi.JavaTypeElement

setInApi

public void setInApi(boolean inApi)

setInApiThroughUse

public void setInApiThroughUse(boolean inApiThroughUse)

setRawUseSites

public void setRawUseSites(Set<ClassPathUseSite> rawUseSites)

compareTo

public int compareTo(@Nonnull
                     org.revapi.Element o)

Specified by:

compareTo in interface Comparable<org.revapi.Element>

Overrides:

compareTo in class JavaElementBase<TypeElement,DeclaredType>

createFullHumanReadableString

protected String createFullHumanReadableString()

Overrides:

createFullHumanReadableString in class JavaElementBase<TypeElement,DeclaredType>

createComparableSignature

protected String createComparableSignature()

Specified by:

createComparableSignature in class JavaElementBase<TypeElement,DeclaredType>