Top Description Constructors Methods
com.github.javaparser.ast.body

public Class AnnotationDeclaration

extends TypeDeclaration<AnnotationDeclaration>
implements NodeWithAbstractModifier<AnnotationDeclaration>, Resolvable<ResolvedAnnotationDeclaration>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.resolution.Resolvable, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithAbstractModifier, com.github.javaparser.ast.nodeTypes.NodeWithModifiers
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Modifier, .Node, .NodeList, .Generated, com.github.javaparser.ast.expr.AnnotationExpr, .SimpleName, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithAbstractModifier, com.github.javaparser.ast.type.Type, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.AnnotationDeclarationMetaModel, .JavaParserMetaModel, com.github.javaparser.TokenRange, com.github.javaparser.resolution.Resolvable, com.github.javaparser.resolution.declarations.ResolvedAnnotationDeclaration, java.util.function.Consumer, java.util.Optional
An annotation type declaration.
@interface X { ... }
Author
Julio Vilmar Gesser

Constructor Summary

AccessConstructor and Description
public
AnnotationDeclaration()

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

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

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 Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public FieldDeclaration
addField(Type
the type of the field
type, String
the name of the field
name, Modifier.Keyword...
the modifiers like Modifier.Keyword#PUBLIC
modifiers)

Overrides default com.github.javaparser.ast.nodeTypes.NodeWithMembers.addField.

Add a field to this.
public AnnotationDeclaration
asAnnotationDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.asAnnotationDeclaration.

public AnnotationDeclaration
clone()

Overrides com.github.javaparser.ast.body.TypeDeclaration.clone.

Creates and returns a copy of this object.
public AnnotationDeclarationMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.body.TypeDeclaration.getMetaModel.

public void
ifAnnotationDeclaration(Consumer<AnnotationDeclaration> action)

Overrides com.github.javaparser.ast.body.BodyDeclaration.ifAnnotationDeclaration.

public boolean
isAnnotationDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.isAnnotationDeclaration.

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.body.TypeDeclaration.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.body.TypeDeclaration.replace.

public ResolvedAnnotationDeclaration
resolve()

Implements abstract com.github.javaparser.ast.body.TypeDeclaration.resolve.

Implements com.github.javaparser.resolution.Resolvable.resolve.

public Optional<AnnotationDeclaration>
toAnnotationDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.toAnnotationDeclaration.

Inherited from com.github.javaparser.ast.body.TypeDeclaration:
addMemberasTypeDeclarationgetCallablesWithSignaturegetFullyQualifiedNamegetMembersgetModifiersgetNameifTypeDeclarationisNestedTypeisTopLevelTypeisTypeDeclarationsetMemberssetModifierssetNametoTypeDeclaration

Constructor Detail

AnnotationDeclarationback to summary
public AnnotationDeclaration()
AnnotationDeclarationback to summary
public AnnotationDeclaration(NodeList<Modifier> modifiers, String name)
AnnotationDeclarationback to summary
public AnnotationDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<BodyDeclaration<?>> members)
Annotations
@AllFieldsConstructor
AnnotationDeclarationback to summary
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.

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
addFieldback to summary
public FieldDeclaration addField(Type type, String name, Modifier.Keyword... modifiers)

Overrides default com.github.javaparser.ast.nodeTypes.NodeWithMembers.addField.

Doc from com.github.javaparser.ast.nodeTypes.NodeWithMembers.addField.

Add a field to this.

Parameters
type:Type

the type of the field

name:String

the name of the field

modifiers:Modifier.Keyword[]

the modifiers like Modifier.Keyword#PUBLIC

Returns:FieldDeclaration

the FieldDeclaration created

Annotations
@Override
asAnnotationDeclarationback to summary
public AnnotationDeclaration asAnnotationDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.asAnnotationDeclaration.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public AnnotationDeclaration clone()

Overrides com.github.javaparser.ast.body.TypeDeclaration.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:AnnotationDeclaration

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getMetaModelback to summary
public AnnotationDeclarationMetaModel getMetaModel()

Overrides com.github.javaparser.ast.body.TypeDeclaration.getMetaModel.

Returns:AnnotationDeclarationMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifAnnotationDeclarationback to summary
public void ifAnnotationDeclaration(Consumer<AnnotationDeclaration> action)

Overrides com.github.javaparser.ast.body.BodyDeclaration.ifAnnotationDeclaration.

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isAnnotationDeclarationback to summary
public boolean isAnnotationDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.isAnnotationDeclaration.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.body.TypeDeclaration.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.body.TypeDeclaration.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
resolveback to summary
public ResolvedAnnotationDeclaration resolve()

Implements abstract com.github.javaparser.ast.body.TypeDeclaration.resolve.

Implements com.github.javaparser.resolution.Resolvable.resolve.

Annotations
@Override
toAnnotationDeclarationback to summary
public Optional<AnnotationDeclaration> toAnnotationDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.toAnnotationDeclaration.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator