org.revapi.java.model

Class TypeElement

java.lang.Object

org.revapi.simple.SimpleElement

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 org.revapi.simple.SimpleElement
implements org.revapi.java.spi.JavaTypeElement

Since:

0.1

Author:

Lukas Krejci

Field Summary

Fields

Modifier and Type	Field and Description
protected T	element
protected ProbingEnvironment	environment

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) 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()
boolean	equals(Object obj)
org.revapi.API	getApi()
org.revapi.Archive	getArchive()
String	getBinaryName()
String	getCanonicalName()
SortedSet<org.revapi.java.spi.JavaElement>	getChildren()
protected String	getComparableSignature()
String	getFullHumanReadableString()
protected String	getHumanReadableElementType()
TypeElement	getModelElement()
org.revapi.java.spi.TypeEnvironment	getTypeEnvironment()
int	hashCode()
boolean	isInnerClass()
String	toString()

Methods inherited from class org.revapi.simple.SimpleElement

getDirectChildrenOfType, getParent, iterateOverChildren, newChildrenInstance, searchChildren, searchChildren, setParent

Methods inherited from class java.lang.Object

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

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

getTypeEnvironment

Methods inherited from interface org.revapi.Element

getApi, getArchive, getChildren, getParent, iterateOverChildren, searchChildren, searchChildren, setParent

Field Detail

environment

protected final ProbingEnvironment environment

element

protected T extends Element element

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)

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

isInnerClass

public boolean isInnerClass()

getHumanReadableElementType

@Nonnull
protected String getHumanReadableElementType()

getModelElement

@Nonnull
public TypeElement getModelElement()

Specified by:

getModelElement in interface org.revapi.java.spi.JavaModelElement

Specified by:

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

getBinaryName

public String getBinaryName()

getCanonicalName

public String getCanonicalName()

compareTo

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

Specified by:

compareTo in interface Comparable<org.revapi.Element>

getFullHumanReadableString

@Nonnull
public String getFullHumanReadableString()

Specified by:

getFullHumanReadableString in interface org.revapi.Element

createComparableSignature

protected String createComparableSignature()

getApi

@Nonnull
public org.revapi.API getApi()

Specified by:

getApi in interface org.revapi.Element

getArchive

@Nullable
public org.revapi.Archive getArchive()

Specified by:

getArchive in interface org.revapi.Element

getTypeEnvironment

@Nonnull
public org.revapi.java.spi.TypeEnvironment getTypeEnvironment()

Specified by:

getTypeEnvironment in interface org.revapi.java.spi.JavaElement

getChildren

@Nonnull
public SortedSet<org.revapi.java.spi.JavaElement> getChildren()

Specified by:

getChildren in interface org.revapi.Element

Overrides:

getChildren in class org.revapi.simple.SimpleElement

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getComparableSignature

protected String getComparableSignature()