org.eclipse.jdt.internal.core
Class Annotation

java.lang.Object
  org.eclipse.core.runtime.PlatformObject
      org.eclipse.jdt.internal.core.JavaElement
          org.eclipse.jdt.internal.core.SourceRefElement
              org.eclipse.jdt.internal.core.Annotation

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IAnnotation, IJavaElement, ISourceReference

Direct Known Subclasses:

AssistAnnotation

public class Annotation
extends SourceRefElement
implements IAnnotation

Field Summary

static IAnnotation[]	NO_ANNOTATIONS
static IMemberValuePair[]	NO_MEMBER_VALUE_PAIRS

Fields inherited from class org.eclipse.jdt.internal.core.SourceRefElement

occurrenceCount

Fields inherited from class org.eclipse.jdt.internal.core.JavaElement

JEM_ANNOTATION, JEM_CLASSFILE, JEM_COMPILATIONUNIT, JEM_COUNT, JEM_ESCAPE, JEM_FIELD, JEM_IMPORTDECLARATION, JEM_INITIALIZER, JEM_JAVAPROJECT, JEM_LOCALVARIABLE, JEM_METHOD, JEM_PACKAGEDECLARATION, JEM_PACKAGEFRAGMENT, JEM_PACKAGEFRAGMENTROOT, JEM_TYPE, JEM_TYPE_PARAMETER

Fields inherited from interface org.eclipse.jdt.core.IJavaElement

ANNOTATION, CLASS_FILE, COMPILATION_UNIT, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVA_MODEL, JAVA_PROJECT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER

Constructor Summary

Annotation(JavaElement parent, java.lang.String name)

Method Summary

boolean	equals(java.lang.Object o) Returns true if this handle represents the same Java element as the given handle.
IClassFile	getClassFile()
IMember	getDeclaringMember()
java.lang.String	getElementName() Returns the name of this element.
int	getElementType() Returns this element's kind encoded as an integer.
IMemberValuePair[]	getMemberValuePairs() Returns the member-value pairs of this annotation.
ISourceRange	getNameRange() Returns the source range of this annotation's name, or null if this annotation does not have associated source code (for example, in a binary type).
ISourceRange	getSourceRange() Returns the source range associated with this element.

Methods inherited from class org.eclipse.jdt.internal.core.SourceRefElement

copy, delete, findNode, getAnnotation, getAnnotations, getCompilationUnit, getCorrespondingResource, getHandleFromMemento, getHandleUpdatingCountFromMemento, getOccurrenceCount, getOpenableParent, getPath, getSource, getUnderlyingResource, hasChildren, isStructureKnown, move, rename, resource

Methods inherited from class org.eclipse.jdt.internal.core.JavaElement

close, exists, getAncestor, getAttachedJavadoc, getChildren, getChildrenOfType, getElementInfo, getElementInfo, getHandleFromMemento, getHandleIdentifier, getHandleMemento, getJavaModel, getJavaProject, getOpenable, getParent, getPrimaryElement, getPrimaryElement, getResource, getSchedulingRule, getSourceMapper, hashCode, isAncestorOf, isReadOnly, newJavaModelException, newNotPresentException, readableName, resolved, toDebugString, toString, toStringInfo, toStringWithAncestors, toStringWithAncestors, unresolved

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jdt.core.IAnnotation

getOccurrenceCount

Methods inherited from interface org.eclipse.jdt.core.IJavaElement

exists, getAncestor, getAttachedJavadoc, getCorrespondingResource, getHandleIdentifier, getJavaModel, getJavaProject, getOpenable, getParent, getPath, getPrimaryElement, getResource, getSchedulingRule, getUnderlyingResource, isReadOnly, isStructureKnown

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jdt.core.ISourceReference

exists, getSource

Field Detail

NO_ANNOTATIONS

public static final IAnnotation[] NO_ANNOTATIONS

NO_MEMBER_VALUE_PAIRS

public static final IMemberValuePair[] NO_MEMBER_VALUE_PAIRS

Constructor Detail

Annotation

public Annotation(JavaElement parent,
                  java.lang.String name)

Method Detail

equals

public boolean equals(java.lang.Object o)

Description copied from class: JavaElement

Returns true if this handle represents the same Java element as the given handle. By default, two handles represent the same element if they are identical or if they represent the same type of element, have equal names, parents, and occurrence counts.

If a subclass has other requirements for equality, this method must be overridden.

Overrides:

equals in class SourceRefElement

See Also:

Object.equals(java.lang.Object)

getDeclaringMember

public IMember getDeclaringMember()

getElementName

public java.lang.String getElementName()

Description copied from interface: IJavaElement

Returns the name of this element. This is a handle-only method.

Specified by:

getElementName in interface IAnnotation

Specified by:

getElementName in interface IJavaElement

Overrides:

getElementName in class JavaElement

Returns:

the element name

See Also:

IAdaptable

getElementType

public int getElementType()

Description copied from interface: IJavaElement

Returns this element's kind encoded as an integer. This is a handle-only method.

Specified by:

getElementType in interface IJavaElement

Returns:

the kind of element; one of the constants declared in IJavaElement

See Also:

IJavaElement

getMemberValuePairs

public IMemberValuePair[] getMemberValuePairs()
                                       throws JavaModelException

Description copied from interface: IAnnotation

Returns the member-value pairs of this annotation. Returns an empty array if this annotation is a marker annotation. Returns a size-1 array if this annotation is a single member annotation. In this case, the member name is always "value".

Specified by:

getMemberValuePairs in interface IAnnotation

Returns:

the member-value pairs of this annotation

Throws:

JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource

getNameRange

public ISourceRange getNameRange()
                          throws JavaModelException

Description copied from interface: IAnnotation

Returns the source range of this annotation's name, or null if this annotation does not have associated source code (for example, in a binary type).

Specified by:

getNameRange in interface IAnnotation

Returns:

the source range of this annotation's name, or null if this annotation does not have associated source code (for example, in a binary type)

Throws:

JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

getSourceRange

public ISourceRange getSourceRange()
                            throws JavaModelException

Description copied from interface: ISourceReference

Returns the source range associated with this element.

For class files, this returns the range of the entire compilation unit associated with the class file (if there is one).

If this element has no associated source code null is either returned, or a source range with a -1 offset and a 0 length.

Specified by:

getSourceRange in interface ISourceReference

Overrides:

getSourceRange in class SourceRefElement

Returns:

the source range, or either null or [-1, 0] if this element has no associated source code

Throws:

JavaModelException - if an exception occurs while accessing its corresponding resource

See Also:

ISourceReference

getClassFile

public IClassFile getClassFile()

Overrides:

getClassFile in class JavaElement

See Also:

IMember