com.bea.util.jam
Interface JElement

All Known Subinterfaces:

JAnnotatedElement, JAnnotation, JClass, JComment, JConstructor, JField, JImport, JInvokable, JMember, JMethod, JPackage, JParameter, JProperty, JTag

public interface JElement

The root of the java type object model.

getParent

JElement getParent()

Returns the parent of this abstraction, or null if this annotation represents a root abstraction (i.e. a JPackage). The JElement hierarchy looks like this:

     JPackage
       JClass
         JConstructor
         JField
         JMethod
           JParameter
         JProperty
         JClass (inner class)...
 

Additionally, any of the abstractions above may in turn have child JAnnotations, which may themselves have child JAnnotations.

getSimpleName

String getSimpleName()

Returns a simple name of this abstraction. The exact format of the name depends on the particular abstraction (see javadoc). Please refer to the JAM package documentation for more details on naming conventions.

getQualifiedName

String getQualifiedName()

Returns a qualified name for this abstraction. The exact format of this name depends on the particular abstraction. Please refer to the documentation for each JElement subclass for a detailed description of the qualified name formats.

getSourcePosition

JSourcePosition getSourcePosition()

Returns an object describing the source file position of this elements, or null if the position is unknown on not applicable.

accept

void accept(JVisitor visitor)

Accepts the given visitor.

getArtifact

Object getArtifact()

This is not something you want to mess with. It's here only for the benefit of some JAM implementations which need a handle back to the actual implementation-specific object which is being proxied by this JElement.

isSourceAvailable

boolean isSourceAvailable()

Returns true if this JElement was parsed from a source file. If false, you can not rely on the availablilty of documentation and line numbers for the element.

toString

String toString()

Returns the same String as getQualifiedName().

Overrides:

toString in class Object