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

public Class EnumConstantDeclaration

extends BodyDeclaration<EnumConstantDeclaration>
implements NodeWithJavadoc<EnumConstantDeclaration>, NodeWithSimpleName<EnumConstantDeclaration>, NodeWithArguments<EnumConstantDeclaration>, Resolvable<ResolvedEnumConstantDeclaration>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.resolution.Resolvable, com.github.javaparser.ast.nodeTypes.NodeWithArguments, com.github.javaparser.ast.nodeTypes.NodeWithSimpleName, com.github.javaparser.ast.nodeTypes.NodeWithJavadoc
Imports
com.github.javaparser.ast.AllFieldsConstructor, .NodeList, .Node, .Generated, com.github.javaparser.ast.expr.AnnotationExpr, .Expression, .SimpleName, com.github.javaparser.ast.nodeTypes.NodeWithArguments, .NodeWithJavadoc, .NodeWithSimpleName, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.GenericVisitor, .VoidVisitor, .CloneVisitor, com.github.javaparser.metamodel.EnumConstantDeclarationMetaModel, .JavaParserMetaModel, com.github.javaparser.TokenRange, com.github.javaparser.resolution.Resolvable, com.github.javaparser.resolution.declarations.ResolvedEnumConstantDeclaration, java.util.function.Consumer, java.util.Optional
One of the values an enum can take. A(1) and B(2) in this example: enum X { A(1), B(2) }
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
private NodeList<Expression>
arguments

private NodeList<BodyDeclaration<?>>
classBody

private SimpleName
name

Constructor Summary

AccessConstructor and Description
public
EnumConstantDeclaration()

public
EnumConstantDeclaration(String name)

public
EnumConstantDeclaration(NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<Expression> arguments, NodeList<BodyDeclaration<?>> classBody)

public
EnumConstantDeclaration(TokenRange tokenRange, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<Expression> arguments, NodeList<BodyDeclaration<?>> classBody)

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 EnumConstantDeclaration
asEnumConstantDeclaration()

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

public EnumConstantDeclaration
clone()

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

Creates and returns a copy of this object.
public NodeList<Expression>
getArguments()

Implements com.github.javaparser.ast.nodeTypes.NodeWithArguments.getArguments.

public NodeList<BodyDeclaration<?>>
getClassBody()

public EnumConstantDeclarationMetaModel
getMetaModel()

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

public SimpleName
getName()

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

public void
ifEnumConstantDeclaration(Consumer<EnumConstantDeclaration> action)

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

public boolean
isEnumConstantDeclaration()

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

public boolean
remove(Node node)

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

public boolean
replace(Node node, Node replacementNode)

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

public ResolvedEnumConstantDeclaration
resolve()

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

public EnumConstantDeclaration
setArguments(final NodeList<Expression> arguments)

Implements com.github.javaparser.ast.nodeTypes.NodeWithArguments.setArguments.

public EnumConstantDeclaration
setClassBody(final NodeList<BodyDeclaration<?>> classBody)

public EnumConstantDeclaration
setName(final SimpleName name)

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

public Optional<EnumConstantDeclaration>
toEnumConstantDeclaration()

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

Inherited from com.github.javaparser.ast.body.BodyDeclaration:
asAnnotationDeclarationasAnnotationMemberDeclarationasCallableDeclarationasClassOrInterfaceDeclarationasConstructorDeclarationasEnumDeclarationasFieldDeclarationasInitializerDeclarationasMethodDeclarationasTypeDeclarationgetAnnotationsifAnnotationDeclarationifAnnotationMemberDeclarationifCallableDeclarationifClassOrInterfaceDeclarationifConstructorDeclarationifEnumDeclarationifFieldDeclarationifInitializerDeclarationifMethodDeclarationifTypeDeclarationisAnnotationDeclarationisAnnotationMemberDeclarationisCallableDeclarationisClassOrInterfaceDeclarationisConstructorDeclarationisEnumDeclarationisFieldDeclarationisInitializerDeclarationisMethodDeclarationisTypeDeclarationsetAnnotationstoAnnotationDeclarationtoAnnotationMemberDeclarationtoCallableDeclarationtoClassOrInterfaceDeclarationtoConstructorDeclarationtoEnumDeclarationtoFieldDeclarationtoInitializerDeclarationtoMethodDeclarationtoTypeDeclaration

Field Detail

argumentsback to summary
private NodeList<Expression> arguments
classBodyback to summary
private NodeList<BodyDeclaration<?>> classBody
nameback to summary
private SimpleName name

Constructor Detail

EnumConstantDeclarationback to summary
public EnumConstantDeclaration()
EnumConstantDeclarationback to summary
public EnumConstantDeclaration(String name)
EnumConstantDeclarationback to summary
public EnumConstantDeclaration(NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<Expression> arguments, NodeList<BodyDeclaration<?>> classBody)
Annotations
@AllFieldsConstructor
EnumConstantDeclarationback to summary
public EnumConstantDeclaration(TokenRange tokenRange, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<Expression> arguments, NodeList<BodyDeclaration<?>> classBody)

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
asEnumConstantDeclarationback to summary
public EnumConstantDeclaration asEnumConstantDeclaration()

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

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

Overrides com.github.javaparser.ast.body.BodyDeclaration.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:EnumConstantDeclaration

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getArgumentsback to summary
public NodeList<Expression> getArguments()

Implements com.github.javaparser.ast.nodeTypes.NodeWithArguments.getArguments.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getClassBodyback to summary
public NodeList<BodyDeclaration<?>> getClassBody()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public EnumConstantDeclarationMetaModel getMetaModel()

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

Returns:EnumConstantDeclarationMetaModel

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 SimpleName getName()

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

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
ifEnumConstantDeclarationback to summary
public void ifEnumConstantDeclaration(Consumer<EnumConstantDeclaration> action)

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

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

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

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

Overrides com.github.javaparser.ast.body.BodyDeclaration.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.BodyDeclaration.replace.

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

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

Annotations
@Override
setArgumentsback to summary
public EnumConstantDeclaration setArguments(final NodeList<Expression> arguments)

Implements com.github.javaparser.ast.nodeTypes.NodeWithArguments.setArguments.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setClassBodyback to summary
public EnumConstantDeclaration setClassBody(final NodeList<BodyDeclaration<?>> classBody)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setNameback to summary
public EnumConstantDeclaration setName(final SimpleName name)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toEnumConstantDeclarationback to summary
public Optional<EnumConstantDeclaration> toEnumConstantDeclaration()

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

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