Top Description Fields Constructors Methods
com.github.javaparser.ast.expr

public abstract Class AnnotationExpr

extends Expression
implements NodeWithName<AnnotationExpr>, Resolvable<ResolvedAnnotationDeclaration>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.resolution.Resolvable, com.github.javaparser.ast.nodeTypes.NodeWithName
Known Direct Subclasses
com.github.javaparser.ast.expr.MarkerAnnotationExpr, com.github.javaparser.ast.expr.NormalAnnotationExpr, com.github.javaparser.ast.expr.SingleMemberAnnotationExpr
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.AllFieldsConstructor, .Generated, .Node, com.github.javaparser.ast.nodeTypes.NodeWithName, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.CloneVisitor, com.github.javaparser.metamodel.AnnotationExprMetaModel, .JavaParserMetaModel, com.github.javaparser.resolution.Resolvable, .UnsolvedSymbolException, com.github.javaparser.resolution.declarations.ResolvedAnnotationDeclaration, java.util.Optional, java.util.function.Consumer
A base class for the different types of annotations.
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
protected Name
name

Constructor Summary

AccessConstructor and Description
public
AnnotationExpr()

public
AnnotationExpr(Name name)

public
AnnotationExpr(TokenRange tokenRange, Name name)

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

Method Summary

Modifier and TypeMethod and Description
public AnnotationExpr
asAnnotationExpr()

Overrides com.github.javaparser.ast.expr.Expression.asAnnotationExpr.

public AnnotationExpr
clone()

Overrides com.github.javaparser.ast.expr.Expression.clone.

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

Overrides com.github.javaparser.ast.expr.Expression.getMetaModel.

public Name
getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.getName.

public void
ifAnnotationExpr(Consumer<AnnotationExpr> action)

Overrides com.github.javaparser.ast.expr.Expression.ifAnnotationExpr.

public boolean
isAnnotationExpr()

Overrides com.github.javaparser.ast.expr.Expression.isAnnotationExpr.

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.expr.Expression.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.expr.Expression.replace.

public ResolvedAnnotationDeclaration

Returns:

a ResolvedAnnotationDeclaration representing the declaration of the annotation expression.
resolve()

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

Attempts to resolve the declaration corresponding to the annotation expression.
public AnnotationExpr
setName(final Name name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.setName.

public Optional<AnnotationExpr>
toAnnotationExpr()

Overrides com.github.javaparser.ast.expr.Expression.toAnnotationExpr.

Inherited from com.github.javaparser.ast.expr.Expression:
asArrayAccessExprasArrayCreationExprasArrayInitializerExprasAssignExprasBinaryExprasBooleanLiteralExprasCastExprasCharLiteralExprasClassExprasConditionalExprasDoubleLiteralExprasEnclosedExprasFieldAccessExprasInstanceOfExprasIntegerLiteralExprasLambdaExprasLiteralExprasLiteralStringValueExprasLongLiteralExprasMarkerAnnotationExprasMethodCallExprasMethodReferenceExprasNameExprasNormalAnnotationExprasNullLiteralExprasObjectCreationExprasSingleMemberAnnotationExprasStringLiteralExprasSuperExprasSwitchExprasTextBlockLiteralExprasThisExprasTypeExprasUnaryExprasVariableDeclarationExprcalculateResolvedTypeifArrayAccessExprifArrayCreationExprifArrayInitializerExprifAssignExprifBinaryExprifBooleanLiteralExprifCastExprifCharLiteralExprifClassExprifConditionalExprifDoubleLiteralExprifEnclosedExprifFieldAccessExprifInstanceOfExprifIntegerLiteralExprifLambdaExprifLiteralExprifLiteralStringValueExprifLongLiteralExprifMarkerAnnotationExprifMethodCallExprifMethodReferenceExprifNameExprifNormalAnnotationExprifNullLiteralExprifObjectCreationExprifSingleMemberAnnotationExprifStringLiteralExprifSuperExprifSwitchExprifTextBlockLiteralExprifThisExprifTypeExprifUnaryExprifVariableDeclarationExprisArrayAccessExprisArrayCreationExprisArrayInitializerExprisAssignExprisBinaryExprisBooleanLiteralExprisCastExprisCharLiteralExprisClassExprisConditionalExprisDoubleLiteralExprisEnclosedExprisFieldAccessExprisInstanceOfExprisIntegerLiteralExprisLambdaExprisLiteralExprisLiteralStringValueExprisLongLiteralExprisMarkerAnnotationExprisMethodCallExprisMethodReferenceExprisNameExprisNormalAnnotationExprisNullLiteralExprisObjectCreationExprisSingleMemberAnnotationExprisStringLiteralExprisSuperExprisSwitchExprisTextBlockLiteralExprisThisExprisTypeExprisUnaryExprisVariableDeclarationExprtoArrayAccessExprtoArrayCreationExprtoArrayInitializerExprtoAssignExprtoBinaryExprtoBooleanLiteralExprtoCastExprtoCharLiteralExprtoClassExprtoConditionalExprtoDoubleLiteralExprtoEnclosedExprtoFieldAccessExprtoInstanceOfExprtoIntegerLiteralExprtoLambdaExprtoLiteralExprtoLiteralStringValueExprtoLongLiteralExprtoMarkerAnnotationExprtoMethodCallExprtoMethodReferenceExprtoNameExprtoNormalAnnotationExprtoNullLiteralExprtoObjectCreationExprtoSingleMemberAnnotationExprtoStringLiteralExprtoSuperExprtoSwitchExprtoTextBlockLiteralExprtoThisExprtoTypeExprtoUnaryExprtoVariableDeclarationExpr

Field Detail

nameback to summary
protected Name name

Constructor Detail

AnnotationExprback to summary
public AnnotationExpr()
AnnotationExprback to summary
public AnnotationExpr(Name name)
Annotations
@AllFieldsConstructor
AnnotationExprback to summary
public AnnotationExpr(TokenRange tokenRange, Name name)

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

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

Method Detail

asAnnotationExprback to summary
public AnnotationExpr asAnnotationExpr()

Overrides com.github.javaparser.ast.expr.Expression.asAnnotationExpr.

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

Overrides com.github.javaparser.ast.expr.Expression.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:AnnotationExpr

a clone of this instance.

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

Overrides com.github.javaparser.ast.expr.Expression.getMetaModel.

Returns:AnnotationExprMetaModel

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

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getNameback to summary
public Name getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.getName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
ifAnnotationExprback to summary
public void ifAnnotationExpr(Consumer<AnnotationExpr> action)

Overrides com.github.javaparser.ast.expr.Expression.ifAnnotationExpr.

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

Overrides com.github.javaparser.ast.expr.Expression.isAnnotationExpr.

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

Overrides com.github.javaparser.ast.expr.Expression.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.expr.Expression.replace.

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

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

Attempts to resolve the declaration corresponding to the annotation expression. If successful, a ResolvedAnnotationDeclaration representing the declaration of the annotation referenced by this AnnotationExpr is returned. Otherwise, an UnsolvedSymbolException is thrown.

Returns:ResolvedAnnotationDeclaration

a ResolvedAnnotationDeclaration representing the declaration of the annotation expression.

Annotations
@Override
Exceptions
UnsolvedSymbolException:
if the declaration corresponding to the annotation expression could not be resolved.
setNameback to summary
public AnnotationExpr setName(final Name name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.setName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toAnnotationExprback to summary
public Optional<AnnotationExpr> toAnnotationExpr()

Overrides com.github.javaparser.ast.expr.Expression.toAnnotationExpr.

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