org.jboss.forge.parser.java

Interface JavaAnnotation

All Superinterfaces:

AnnotationTarget<JavaAnnotation,JavaAnnotation>, Importer<JavaAnnotation>, Internal, JavaSource<JavaAnnotation>, MemberHolder<JavaAnnotation,Member>, Named<JavaAnnotation>, Origin<JavaAnnotation>, Packaged<JavaAnnotation>, VisibilityScoped<JavaAnnotation>

public interface JavaAnnotation
extends JavaSource<JavaAnnotation>

Represents a Java Annotation source file as an in-memory modifiable element. See JavaParser for various options in generating JavaAnnotation instances.

Author:

Lincoln Baxter, III

Method Summary

Methods

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

Methods inherited from interface org.jboss.forge.parser.java.JavaSource

getCanonicalName, getEnclosingType, getNestedClasses, getQualifiedName, getSourceType, getSyntaxErrors, hasSyntaxErrors, isAnnotation, isClass, isEnum, isInterface

Methods inherited from interface org.jboss.forge.parser.java.Packaged

getPackage, isDefaultPackage, setDefaultPackage, setPackage

Methods inherited from interface org.jboss.forge.parser.java.Importer

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.parser.java.Named

getName, setName

Methods inherited from interface org.jboss.forge.parser.java.VisibilityScoped

getVisibility, isPackagePrivate, isPrivate, isProtected, isPublic, setPackagePrivate, setPrivate, setProtected, setPublic, setVisibility

Methods inherited from interface org.jboss.forge.parser.java.AnnotationTarget

addAnnotation, addAnnotation, addAnnotation, getAnnotation, getAnnotation, getAnnotations, hasAnnotation, hasAnnotation, removeAnnotation

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

getInternal

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

getOrigin

Methods inherited from interface org.jboss.forge.parser.java.MemberHolder

getMembers

Method Detail

addAnnotationElement

AnnotationElement addAnnotationElement()

Add a new Java AnnotationElement to this JavaAnnotation instance. This will be a stub until further modified.

addAnnotationElement

AnnotationElement addAnnotationElement(String declaration)

Add a new AnnotationElement declaration to this JavaAnnotation instance, using the given String as the declaration.

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

hasAnnotationElement

boolean hasAnnotationElement(String name)

Return whether or not this JavaAnnotation declares an AnnotationElement with the given name.

hasAnnotationElement

boolean hasAnnotationElement(AnnotationElement annotationElement)

Return whether or not this JavaAnnotation declares the given AnnotationElement instance.

getAnnotationElement

AnnotationElement getAnnotationElement(String name)

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

getAnnotationElements

List<AnnotationElement> getAnnotationElements()

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

removeAnnotationElement

JavaAnnotation removeAnnotationElement(AnnotationElement annotationElement)

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