com.webcohesion.enunciate.javac.decorations.element

Class DecoratedElement<E extends Element>

java.lang.Object

com.webcohesion.enunciate.javac.decorations.element.DecoratedElement<E>

All Implemented Interfaces:

Element

Direct Known Subclasses:

DecoratedExecutableElement, DecoratedPackageElement, DecoratedTypeElement, DecoratedTypeParameterElement, DecoratedVariableElement

public class DecoratedElement<E extends Element>
extends Object
implements Element

Field Summary

Fields

Modifier and Type	Field and Description
protected E	delegate
protected DecoratedProcessingEnvironment	env

Constructor Summary

Constructors

Constructor and Description
DecoratedElement(E delegate, DecoratedProcessingEnvironment env)

Method Summary

Methods

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> v, P p)
TypeMirror	asType()
boolean	equals(Object obj)
<A extends Annotation> A	getAnnotation(Class<A> annotationType)
List<? extends AnnotationMirror>	getAnnotationMirrors()
Map<String,AnnotationMirror>	getAnnotations() A map of annotations for this declaration.
E	getDelegate()
String	getDocComment()
String	getDocValue() The value of the java doc, before the block tags.
String	getDocValue(JavaDocTagHandler tagHandler) The value of the java doc, before the block tags.
List<? extends Element>	getEnclosedElements()
Element	getEnclosingElement()
JavaDoc	getJavaDoc() The javadoc for this declaration with the default tag handler.
JavaDoc	getJavaDoc(JavaDocTagHandler tagHandler) Get the JavaDoc for this element for the given tag handler.
protected JavaDoc	getJavaDoc(JavaDocTagHandler tagHandler, boolean useDelegate)
ElementKind	getKind()
Set<Modifier>	getModifiers()
Name	getSimpleName()
boolean	isAbstract() Whether the declaration is abstract.
boolean	isFinal() Whether the declaration is final.
boolean	isNative() Whether the declaration is native.
boolean	isPrivate() Whether the declaration is private.
boolean	isProtected() Whether the declaration is protected.
boolean	isPublic() Whether the declaration is public.
boolean	isStatic() Whether the declaration is static.
boolean	isStrictfp() Whether the declaration is strictfp.
boolean	isSynchronized() Whether the declaration is synchronized.
boolean	isTransient() Whether the declaration is transient.
boolean	isVolatile() Whether the declaration is volatile.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.lang.model.element.Element

hashCode

Field Detail

delegate

protected final E extends Element delegate

env

protected final DecoratedProcessingEnvironment env

Constructor Detail

DecoratedElement

public DecoratedElement(E delegate,
                DecoratedProcessingEnvironment env)

Method Detail

isPublic

public boolean isPublic()

Whether the declaration is public.

Returns:

Whether the declaration is public.

isProtected

public boolean isProtected()

Whether the declaration is protected.

Returns:

Whether the declaration is protected.

isPrivate

public boolean isPrivate()

Whether the declaration is private.

Returns:

Whether the declaration is private.

isAbstract

public boolean isAbstract()

Whether the declaration is abstract.

Returns:

Whether the declaration is abstract.

isStatic

public boolean isStatic()

Whether the declaration is static.

Returns:

Whether the declaration is static.

isFinal

public boolean isFinal()

Whether the declaration is final.

Returns:

Whether the declaration is final.

isTransient

public boolean isTransient()

Whether the declaration is transient.

Returns:

Whether the declaration is transient.

isVolatile

public boolean isVolatile()

Whether the declaration is volatile.

Returns:

Whether the declaration is volatile.

isSynchronized

public boolean isSynchronized()

Whether the declaration is synchronized.

Returns:

Whether the declaration is synchronized.

isNative

public boolean isNative()

Whether the declaration is native.

Returns:

Whether the declaration is native.

isStrictfp

public boolean isStrictfp()

Whether the declaration is strictfp.

Returns:

Whether the declaration is strictfp.

getDocComment

public String getDocComment()

getJavaDoc

public final JavaDoc getJavaDoc()

The javadoc for this declaration with the default tag handler.

Returns:

The javadoc for this declaration with the default tag handler.

getJavaDoc

public final JavaDoc getJavaDoc(JavaDocTagHandler tagHandler)

Get the JavaDoc for this element for the given tag handler.

Parameters:

tagHandler - The tag handler.

Returns:

The javadoc.

getJavaDoc

protected JavaDoc getJavaDoc(JavaDocTagHandler tagHandler,
                 boolean useDelegate)

getDocValue

public final String getDocValue()

The value of the java doc, before the block tags.

Returns:

The value of the java doc, before the block tags, or null if the value is the empty string.

getDocValue

public final String getDocValue(JavaDocTagHandler tagHandler)

The value of the java doc, before the block tags.

Parameters:

tagHandler - The tag handler.

Returns:

The value of the java doc, before the block tags, or null if the value is the empty string.

getAnnotations

public Map<String,AnnotationMirror> getAnnotations()

A map of annotations for this declaration.

Returns:

A map of annotations for this declaration.

asType

public TypeMirror asType()

Specified by:

asType in interface Element

getKind

public ElementKind getKind()

Specified by:

getKind in interface Element

getEnclosingElement

public Element getEnclosingElement()

Specified by:

getEnclosingElement in interface Element

getEnclosedElements

public List<? extends Element> getEnclosedElements()

Specified by:

getEnclosedElements in interface Element

accept

public <R,P> R accept(ElementVisitor<R,P> v,
             P p)

Specified by:

accept in interface Element

getAnnotationMirrors

public List<? extends AnnotationMirror> getAnnotationMirrors()

Specified by:

getAnnotationMirrors in interface Element

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType)

Specified by:

getAnnotation in interface Element

getModifiers

public Set<Modifier> getModifiers()

Specified by:

getModifiers in interface Element

getSimpleName

public Name getSimpleName()

Specified by:

getSimpleName in interface Element

getDelegate

public E getDelegate()

equals

public boolean equals(Object obj)

Specified by:

equals in interface Element

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object