org.apache.xmlbeans.impl.jam.internal.elements

Class AnnotatedElementImpl

java.lang.Object

org.apache.xmlbeans.impl.jam.internal.elements.ElementImpl

org.apache.xmlbeans.impl.jam.internal.elements.AnnotatedElementImpl

All Implemented Interfaces:

Comparable, JAnnotatedElement, JElement, MAnnotatedElement, MElement

Direct Known Subclasses:

BuiltinClassImpl, MemberImpl, PackageImpl, PropertyImpl

public abstract class AnnotatedElementImpl
extends ElementImpl
implements MAnnotatedElement

Field Summary

Fields inherited from class org.apache.xmlbeans.impl.jam.internal.elements.ElementImpl

NO_ANNOTATION, NO_CLASS, NO_COMMENT, NO_CONSTRUCTOR, NO_FIELD, NO_METHOD, NO_NODE, NO_PACKAGE, NO_PARAMETER, NO_PROPERTY

Method Summary

Modifier and Type	Method and Description
MAnnotation	addAnnotationForProxy(Class proxyClass, AnnotationProxy proxy) Deprecated. this is a back door for xbeans. do not use, will be removed soon.
MAnnotation	addLiteralAnnotation(String annName)
MComment	createComment()
MAnnotation	findOrCreateAnnotation(String annotationName) Returns the annotation having the given name, creating it if it doesn't exist.
JAnnotation[]	getAllJavadocTags() Deprecated.
JAnnotation	getAnnotation(Class proxyClass) Returns the JAnnotation which is being proxied by the given subclass of TypedAnnotationProxyBase, or null if no such annotation exists.
JAnnotation	getAnnotation(String named) Returns the annotation that represents the named 175 annotation or javadoc tag on this elements.
Object	getAnnotationProxy(Class proxyClass)
JAnnotation[]	getAnnotations() Returns the metadata JAnnotations that are associated with this abstraction.
JAnnotationValue	getAnnotationValue(String valueId) Shortcut method which returns a given annotation value.
JComment	getComment() Returns the comment associated with this abstraction.
AnnotationProxy	getEditableProxy(Class proxyClass)
MAnnotation	getMutableAnnotation(String named)
MAnnotation[]	getMutableAnnotations()
MComment	getMutableComment()
void	removeAnnotation(MAnnotation ann)
void	removeComment()

Methods inherited from class org.apache.xmlbeans.impl.jam.internal.elements.ElementImpl

compareTo, createSourcePosition, defaultName, equals, getArtifact, getClassLoader, getContext, getMutableSourcePosition, getParent, getSimpleName, getSourcePosition, hashCode, removeSourcePosition, setArtifact, setSimpleName, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.xmlbeans.impl.jam.mutable.MElement

accept, createSourcePosition, getClassLoader, getMutableSourcePosition, removeSourcePosition, setArtifact, setSimpleName

Methods inherited from interface org.apache.xmlbeans.impl.jam.JElement

accept, getArtifact, getParent, getQualifiedName, getSimpleName, getSourcePosition, toString

Method Detail

getAnnotations

public JAnnotation[] getAnnotations()

Description copied from interface: JAnnotatedElement

Returns the metadata JAnnotations that are associated with this abstraction. Returns an empty array if there are no annotations.

Specified by:

getAnnotations in interface JAnnotatedElement

getAnnotation

public JAnnotation getAnnotation(Class proxyClass)

Description copied from interface: JAnnotatedElement

Returns the JAnnotation which is being proxied by the given subclass of TypedAnnotationProxyBase, or null if no such annotation exists. If it does exist, the getProxy() method on the returned object is guaranteed to return be an instance of the proxyClass.

Specified by:

getAnnotation in interface JAnnotatedElement

getAnnotation

public JAnnotation getAnnotation(String named)

Description copied from interface: JAnnotatedElement

Returns the annotation that represents the named 175 annotation or javadoc tag on this elements.

Specified by:

getAnnotation in interface JAnnotatedElement

getAnnotationValue

public JAnnotationValue getAnnotationValue(String valueId)

Description copied from interface: JAnnotatedElement

Shortcut method which returns a given annotation value. The 'valueId' should be a string of the format 'annotation-name@value-name'. The value-name may be ommitted; if it is, it defaults to JAnntoation.SINGLE_MEMBER_VALUE.

Specified by:

getAnnotationValue in interface JAnnotatedElement

Returns:

getAnnotationProxy

public Object getAnnotationProxy(Class proxyClass)

Specified by:

getAnnotationProxy in interface JAnnotatedElement

getComment

public JComment getComment()

Description copied from interface: JAnnotatedElement

Returns the comment associated with this abstraction. Returns null if it has no comment.

Specified by:

getComment in interface JAnnotatedElement

getAllJavadocTags

public JAnnotation[] getAllJavadocTags()

Deprecated.

Specified by:

getAllJavadocTags in interface JAnnotatedElement

getEditableProxy

public AnnotationProxy getEditableProxy(Class proxyClass)

removeAnnotation

public void removeAnnotation(MAnnotation ann)

getMutableAnnotations

public MAnnotation[] getMutableAnnotations()

Specified by:

getMutableAnnotations in interface MAnnotatedElement

getMutableAnnotation

public MAnnotation getMutableAnnotation(String named)

Specified by:

getMutableAnnotation in interface MAnnotatedElement

findOrCreateAnnotation

public MAnnotation findOrCreateAnnotation(String annotationName)

Description copied from interface: MAnnotatedElement

Returns the annotation having the given name, creating it if it doesn't exist.

Specified by:

findOrCreateAnnotation in interface MAnnotatedElement

addLiteralAnnotation

public MAnnotation addLiteralAnnotation(String annName)

Specified by:

addLiteralAnnotation in interface MAnnotatedElement

getMutableComment

public MComment getMutableComment()

Specified by:

getMutableComment in interface MAnnotatedElement

createComment

public MComment createComment()

Specified by:

createComment in interface MAnnotatedElement

removeComment

public void removeComment()

Specified by:

removeComment in interface MAnnotatedElement

addAnnotationForProxy

public MAnnotation addAnnotationForProxy(Class proxyClass,
                                         AnnotationProxy proxy)

Deprecated. this is a back door for xbeans. do not use, will be removed soon.