| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Element
Represents a program element such as a package, class, or method. Each element represents a static, language-level construct (and not, for example, a runtime construct of the virtual machine).
Elements should be compared using the {@link #equals(Object)} method. There is no guarantee that any particular element will always be represented by the same object.
To implement operations based on the class of an {@code Element} object, either use a {@linkplain ElementVisitor visitor} or use the result of the {@link #getKind} method. Using {@code instanceof} is not necessarily a reliable idiom for determining the effective class of an object in this modeling hierarchy since an implementation may choose to have a single object implement multiple {@code Element} subinterfaces.
Method Summary | |
---|---|
Object |
accept(ElementVisitor v, Object p) Applies a visitor to this element. |
TypeMirror |
asType() Returns the type defined by this element. |
boolean |
Returns if the argument represents the same element as , or otherwise. |
Annotation |
getAnnotation(Class annotationType) Returns this element's annotation for the specified type if such an annotation is present, else . |
List |
Returns the annotations that are directly present on this element. |
List |
Returns the elements that are, loosely speaking, directly enclosed by this element. |
Element |
Returns the innermost element within which this element is, loosely speaking, enclosed. |
ElementKind |
getKind() Returns the of this element. |
Set |
Returns the modifiers of this element, excluding annotations. |
Name |
Returns the simple (unqualified) name of this element. |
int |
hashCode() Obeys the general contract of java.lang.Object.hashCode. |
Method Detail |
---|
public Object accept(ElementVisitor v, Object p)
v
- the visitor operating on this elementp
- additional parameter to the visitorpublic TypeMirror asType()
A generic element defines a family of types, not just one.
If this is a generic element, a prototypical type is
returned. This is the element's invocation on the
type variables corresponding to its own formal type parameters.
For example,
for the generic class element {@code C
public boolean equals(Object obj)
Note that the identity of an element involves implicit state not directly accessible from the element's methods, including state about the presence of unrelated types. Element objects created by different implementations of these interfaces should not be expected to be equal even if "the same" element is being modeled; this is analogous to the inequality of {@code Class} objects for the same class file loaded through different class loaders.
equals
in class Object
obj
- the object to be compared with this elementpublic Annotation getAnnotation(Class annotationType)
The annotation returned by this method could contain an element whose value is of type {@code Class}. This value cannot be returned directly: information necessary to locate and load a class (such as the class loader to use) is not available, and the class might not be loadable at all. Attempting to read a {@code Class} object by invoking the relevant method on the returned annotation will result in a {@link MirroredTypeException}, from which the corresponding {@link TypeMirror} may be extracted. Similarly, attempting to read a {@code Class[]}-valued element will result in a {@link MirroredTypesException}.
Note: This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation types currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation types.
annotationType
- the {@code Class} object corresponding to
the annotation typepublic List getAnnotationMirrors()
To get inherited annotations as well, use {@link Elements#getAllAnnotationMirrors(Element) getAllAnnotationMirrors}.
public List getEnclosedElements()
Note that elements of certain kinds can be isolated using methods in {@link ElementFilter}.
public Element getEnclosingElement()
public ElementKind getKind()
public Set getModifiers()
public Name getSimpleName()
public int hashCode()
hashCode
in class Object
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |