com.github.javaparser.ast.body

Class AnnotationDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.body.BodyDeclaration<T>

com.github.javaparser.ast.body.TypeDeclaration<AnnotationDeclaration>

com.github.javaparser.ast.body.AnnotationDeclaration

All Implemented Interfaces:

NodeWithAbstractModifier<AnnotationDeclaration>, NodeWithAccessModifiers<AnnotationDeclaration>, NodeWithPrivateModifier<AnnotationDeclaration>, NodeWithProtectedModifier<AnnotationDeclaration>, NodeWithPublicModifier<AnnotationDeclaration>, NodeWithStaticModifier<AnnotationDeclaration>, NodeWithStrictfpModifier<AnnotationDeclaration>, NodeWithAnnotations<AnnotationDeclaration>, NodeWithJavadoc<AnnotationDeclaration>, NodeWithMembers<AnnotationDeclaration>, NodeWithModifiers<AnnotationDeclaration>, NodeWithRange<Node>, NodeWithSimpleName<AnnotationDeclaration>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, Resolvable<ResolvedAnnotationDeclaration>, Cloneable

public class AnnotationDeclaration
extends TypeDeclaration<AnnotationDeclaration>
implements NodeWithAbstractModifier<AnnotationDeclaration>, Resolvable<ResolvedAnnotationDeclaration>

An annotation type declaration.
@interface X { ... }

Author:

Julio Vilmar Gesser

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor and Description
AnnotationDeclaration()
AnnotationDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<BodyDeclaration<?>> members)
AnnotationDeclaration(NodeList<Modifier> modifiers, String name)
AnnotationDeclaration(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<BodyDeclaration<?>> members) This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg) Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg) Accept method for visitor support.
FieldDeclaration	addField(Type type, String name, Modifier.Keyword... modifiers) Add a field to this.
AnnotationDeclaration	asAnnotationDeclaration()
AnnotationDeclaration	clone()
AnnotationDeclarationMetaModel	getMetaModel()
void	ifAnnotationDeclaration(Consumer<AnnotationDeclaration> action)
boolean	isAnnotationDeclaration()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
ResolvedAnnotationDeclaration	resolve()
Optional<AnnotationDeclaration>	toAnnotationDeclaration()

Methods inherited from class com.github.javaparser.ast.body.TypeDeclaration

addMember, asTypeDeclaration, getCallablesWithSignature, getMembers, getModifiers, getName, ifTypeDeclaration, isNestedType, isTopLevelType, isTypeDeclaration, setMembers, setModifiers, setName, toTypeDeclaration

Methods inherited from class com.github.javaparser.ast.body.BodyDeclaration

asAnnotationMemberDeclaration, asCallableDeclaration, asClassOrInterfaceDeclaration, asConstructorDeclaration, asEnumConstantDeclaration, asEnumDeclaration, asFieldDeclaration, asInitializerDeclaration, asMethodDeclaration, getAnnotations, ifAnnotationMemberDeclaration, ifCallableDeclaration, ifClassOrInterfaceDeclaration, ifConstructorDeclaration, ifEnumConstantDeclaration, ifEnumDeclaration, ifFieldDeclaration, ifInitializerDeclaration, ifMethodDeclaration, isAnnotationMemberDeclaration, isCallableDeclaration, isClassOrInterfaceDeclaration, isConstructorDeclaration, isEnumConstantDeclaration, isEnumDeclaration, isFieldDeclaration, isInitializerDeclaration, isMethodDeclaration, setAnnotations, toAnnotationMemberDeclaration, toCallableDeclaration, toClassOrInterfaceDeclaration, toConstructorDeclaration, toEnumConstantDeclaration, toEnumDeclaration, toFieldDeclaration, toInitializerDeclaration, toMethodDeclaration

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, getToStringPrettyPrinterConfiguration, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, setToStringPrettyPrinterConfiguration, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithAbstractModifier

isAbstract, setAbstract

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithModifiers

addModifier, getAccessSpecifier, getModifiers, hasModifier, removeModifier, setModifier, setModifiers, setModifiers

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithSimpleName

getNameAsExpression, getNameAsString, setName

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithJavadoc

getComment, getJavadoc, getJavadocComment, hasJavaDocComment, removeJavaDocComment, setComment, setJavadocComment, setJavadocComment, setJavadocComment, setJavadocComment

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithMembers

addField, addField, addFieldWithInitializer, addFieldWithInitializer, addFieldWithInitializer, addInitializer, addMethod, addPrivateField, addPrivateField, addPrivateField, addProtectedField, addProtectedField, addProtectedField, addPublicField, addPublicField, addPublicField, addStaticInitializer, getFieldByName, getFields, getMember, getMethods, getMethodsByName, getMethodsByParameterTypes, getMethodsByParameterTypes, getMethodsBySignature, isEmpty, setMember, tryAddImportToParentCompilationUnit

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPublicModifier

isPublic, setPublic

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPrivateModifier

isPrivate, setPrivate

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithProtectedModifier

isProtected, setProtected

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithStaticModifier

isStatic, setStatic

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithStrictfpModifier

isStrictfp, setStrictfp

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithAnnotations

addAndGetAnnotation, addAndGetAnnotation, addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent, setAnnotation, tryAddImportToParentCompilationUnit

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, getBegin, getEnd

Constructor Detail

AnnotationDeclaration

public AnnotationDeclaration()

AnnotationDeclaration

public AnnotationDeclaration(NodeList<Modifier> modifiers,
                             String name)

AnnotationDeclaration

public AnnotationDeclaration(NodeList<Modifier> modifiers,
                             NodeList<AnnotationExpr> annotations,
                             SimpleName name,
                             NodeList<BodyDeclaration<?>> members)

AnnotationDeclaration

public AnnotationDeclaration(TokenRange tokenRange,
                             NodeList<Modifier> modifiers,
                             NodeList<AnnotationExpr> annotations,
                             SimpleName name,
                             NodeList<BodyDeclaration<?>> members)

This constructor is used by the parser and is considered private.

Method Detail

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

remove

public boolean remove(Node node)

Overrides:

remove in class TypeDeclaration<AnnotationDeclaration>

clone

public AnnotationDeclaration clone()

Overrides:

clone in class TypeDeclaration<AnnotationDeclaration>

getMetaModel

public AnnotationDeclarationMetaModel getMetaModel()

Overrides:

getMetaModel in class TypeDeclaration<AnnotationDeclaration>

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class TypeDeclaration<AnnotationDeclaration>

isAnnotationDeclaration

public boolean isAnnotationDeclaration()

Overrides:

isAnnotationDeclaration in class BodyDeclaration<AnnotationDeclaration>

asAnnotationDeclaration

public AnnotationDeclaration asAnnotationDeclaration()

Overrides:

asAnnotationDeclaration in class BodyDeclaration<AnnotationDeclaration>

ifAnnotationDeclaration

public void ifAnnotationDeclaration(Consumer<AnnotationDeclaration> action)

Overrides:

ifAnnotationDeclaration in class BodyDeclaration<AnnotationDeclaration>

resolve

public ResolvedAnnotationDeclaration resolve()

Specified by:

resolve in interface Resolvable<ResolvedAnnotationDeclaration>

Specified by:

resolve in class TypeDeclaration<AnnotationDeclaration>

toAnnotationDeclaration

public Optional<AnnotationDeclaration> toAnnotationDeclaration()

Overrides:

toAnnotationDeclaration in class BodyDeclaration<AnnotationDeclaration>

addField

public FieldDeclaration addField(Type type,
                                 String name,
                                 Modifier.Keyword... modifiers)

Description copied from interface: NodeWithMembers

Add a field to this.

Specified by:

addField in interface NodeWithMembers<AnnotationDeclaration>

Parameters:

type - the type of the field

name - the name of the field

modifiers - the modifiers like Modifier.Keyword#PUBLIC

Returns:

the FieldDeclaration created