Package org.jboss.forge.roaster.model.source

Interface JavaAnnotationSource

All Superinterfaces:

AnnotationTarget<JavaAnnotationSource>, AnnotationTargetSource<JavaAnnotationSource,JavaAnnotationSource>, Importer<JavaAnnotationSource>, Internal, JavaAnnotation<JavaAnnotationSource>, JavaDocCapable<JavaAnnotationSource>, JavaDocCapableSource<JavaAnnotationSource>, JavaSource<JavaAnnotationSource>, JavaType<JavaAnnotationSource>, LocationCapable, Named, NamedSource<JavaAnnotationSource>, Origin<JavaAnnotationSource>, Packaged<JavaAnnotationSource>, PackagedSource<JavaAnnotationSource>, TypeHolder<JavaAnnotationSource>, TypeHolderSource<JavaAnnotationSource>, VisibilityScoped, VisibilityScopedSource<JavaAnnotationSource>

public interface JavaAnnotationSource
extends JavaAnnotation<JavaAnnotationSource>, JavaSource<JavaAnnotationSource>, TypeHolderSource<JavaAnnotationSource>

Represents a Java @interface annotation source file as an in-memory modifiable element. See Roaster for various options in generating JavaAnnotationSource instances.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method	Description
AnnotationElementSource	addAnnotationElement()	Add a new Java AnnotationElementSource to this JavaAnnotationSource instance.
AnnotationElementSource	addAnnotationElement(String declaration)	Add a new AnnotationElementSource declaration to this JavaAnnotationSource instance, using the given String as the declaration.
AnnotationElementSource	getAnnotationElement(String name)	Get the AnnotationElementSource with the given name and return it, otherwise, return null.
List<AnnotationElementSource>	getAnnotationElements()	Get a list of all AnnotationElementSources declared by this JavaAnnotation, or return an empty list if no AnnotationElementSources are declared.
JavaAnnotationSource	removeAnnotationElement(AnnotationElement<?> annotationElement)	Remove the given AnnotationElement from this JavaAnnotationSource instance, if it exists; otherwise, do nothing.

Methods inherited from interface org.jboss.forge.roaster.model.AnnotationTarget

hasAnnotation, hasAnnotation

Methods inherited from interface org.jboss.forge.roaster.model.source.AnnotationTargetSource

addAnnotation, addAnnotation, addAnnotation, getAnnotation, getAnnotation, getAnnotations, removeAllAnnotations, removeAnnotation

Methods inherited from interface org.jboss.forge.roaster.model.source.Importer

addImport, addImport, addImport, addImport, addImport, getImport, getImport, getImport, getImport, getImports, hasImport, hasImport, hasImport, hasImport, removeImport, removeImport, removeImport, removeImport, requiresImport, requiresImport, resolveType

Methods inherited from interface org.jboss.forge.roaster.Internal

getInternal

Methods inherited from interface org.jboss.forge.roaster.model.JavaAnnotation

hasAnnotationElement, hasAnnotationElement

Methods inherited from interface org.jboss.forge.roaster.model.JavaDocCapable

hasJavaDoc

Methods inherited from interface org.jboss.forge.roaster.model.source.JavaDocCapableSource

getJavaDoc, removeJavaDoc

Methods inherited from interface org.jboss.forge.roaster.model.source.JavaSource

getEnclosingType

Methods inherited from interface org.jboss.forge.roaster.model.JavaType

getCanonicalName, getQualifiedName, getSyntaxErrors, hasSyntaxErrors, isAnnotation, isClass, isEnum, isInterface, isRecord, toUnformattedString

Methods inherited from interface org.jboss.forge.roaster.model.source.LocationCapable

getColumnNumber, getEndPosition, getLineNumber, getStartPosition

Methods inherited from interface org.jboss.forge.roaster.model.Named

getName

Methods inherited from interface org.jboss.forge.roaster.model.source.NamedSource

setName

Methods inherited from interface org.jboss.forge.roaster.Origin

getOrigin

Methods inherited from interface org.jboss.forge.roaster.model.Packaged

getPackage, isDefaultPackage

Methods inherited from interface org.jboss.forge.roaster.model.source.PackagedSource

setDefaultPackage, setPackage

Methods inherited from interface org.jboss.forge.roaster.model.TypeHolder

hasNestedType, hasNestedType, hasNestedType

Methods inherited from interface org.jboss.forge.roaster.model.source.TypeHolderSource

addNestedType, addNestedType, addNestedType, getNestedType, getNestedTypes, removeNestedType

Methods inherited from interface org.jboss.forge.roaster.model.VisibilityScoped

getVisibility, isPackagePrivate, isPrivate, isProtected, isPublic

Methods inherited from interface org.jboss.forge.roaster.model.source.VisibilityScopedSource

setPackagePrivate, setPrivate, setProtected, setPublic, setVisibility

Method Details

getAnnotationElement

AnnotationElementSource getAnnotationElement(String name)

Get the AnnotationElementSource with the given name and return it, otherwise, return null.

Specified by:

getAnnotationElement in interface JavaAnnotation<JavaAnnotationSource>

getAnnotationElements

List<AnnotationElementSource> getAnnotationElements()

Get a list of all AnnotationElementSources declared by this JavaAnnotation, or return an empty list if no AnnotationElementSources are declared.

Specified by:

getAnnotationElements in interface JavaAnnotation<JavaAnnotationSource>

addAnnotationElement

AnnotationElementSource addAnnotationElement()

Add a new Java AnnotationElementSource to this JavaAnnotationSource instance. This will be a stub until further modified.

addAnnotationElement

AnnotationElementSource addAnnotationElement(String declaration)

Add a new AnnotationElementSource declaration to this JavaAnnotationSource instance, using the given String as the declaration.

For example:
AnnotationElement e = javaClass.addAnnotationElement("String newAnnotationElement();");

removeAnnotationElement

JavaAnnotationSource removeAnnotationElement(AnnotationElement<?> annotationElement)

Remove the given AnnotationElement from this JavaAnnotationSource instance, if it exists; otherwise, do nothing.