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

public Class EnumDeclaration

extends TypeDeclaration<EnumDeclaration>
implements NodeWithImplements<EnumDeclaration>, Resolvable<ResolvedEnumDeclaration>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.resolution.Resolvable, com.github.javaparser.ast.nodeTypes.NodeWithImplements
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.*, com.github.javaparser.ast.expr.AnnotationExpr, .SimpleName, com.github.javaparser.ast.nodeTypes.NodeWithImplements, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.type.ClassOrInterfaceType, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.EnumDeclarationMetaModel, .JavaParserMetaModel, com.github.javaparser.resolution.Resolvable, com.github.javaparser.resolution.declarations.ResolvedEnumDeclaration, java.util.Optional, java.util.function.Consumer
The declaration of an enum.
enum X { ... }
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
private NodeList<EnumConstantDeclaration>
entries

private NodeList<ClassOrInterfaceType>
implementedTypes

Constructor Summary

AccessConstructor and Description
public
EnumDeclaration()

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

public
EnumDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<ClassOrInterfaceType> implementedTypes, NodeList<EnumConstantDeclaration> entries, NodeList<BodyDeclaration<?>> members)

public
EnumDeclaration(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<ClassOrInterfaceType> implementedTypes, NodeList<EnumConstantDeclaration> entries, 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 EnumDeclaration
addEntry(EnumConstantDeclaration element)

public EnumConstantDeclaration
addEnumConstant(String name)

public EnumDeclaration
asEnumDeclaration()

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

public EnumDeclaration
clone()

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

Creates and returns a copy of this object.
public NodeList<EnumConstantDeclaration>
getEntries()

public EnumConstantDeclaration
getEntry(int i)

public NodeList<ClassOrInterfaceType>
getImplementedTypes()

Implements com.github.javaparser.ast.nodeTypes.NodeWithImplements.getImplementedTypes.

public EnumDeclarationMetaModel
getMetaModel()

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

public void
ifEnumDeclaration(Consumer<EnumDeclaration> action)

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

public boolean
isEnumDeclaration()

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

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 ResolvedEnumDeclaration
resolve()

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

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

public EnumDeclaration
setEntries(final NodeList<EnumConstantDeclaration> entries)

public EnumDeclaration
setEntry(int i, EnumConstantDeclaration element)

public EnumDeclaration
setImplementedTypes(final NodeList<ClassOrInterfaceType> implementedTypes)

Implements com.github.javaparser.ast.nodeTypes.NodeWithImplements.setImplementedTypes.

public Optional<EnumDeclaration>
toEnumDeclaration()

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

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

Field Detail

entriesback to summary
private NodeList<EnumConstantDeclaration> entries
implementedTypesback to summary
private NodeList<ClassOrInterfaceType> implementedTypes

Constructor Detail

EnumDeclarationback to summary
public EnumDeclaration()
EnumDeclarationback to summary
public EnumDeclaration(NodeList<Modifier> modifiers, String name)
EnumDeclarationback to summary
public EnumDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<ClassOrInterfaceType> implementedTypes, NodeList<EnumConstantDeclaration> entries, NodeList<BodyDeclaration<?>> members)
Annotations
@AllFieldsConstructor
EnumDeclarationback to summary
public EnumDeclaration(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<ClassOrInterfaceType> implementedTypes, NodeList<EnumConstantDeclaration> entries, 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
addEntryback to summary
public EnumDeclaration addEntry(EnumConstantDeclaration element)
addEnumConstantback to summary
public EnumConstantDeclaration addEnumConstant(String name)
asEnumDeclarationback to summary
public EnumDeclaration asEnumDeclaration()

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

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public EnumDeclaration 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:EnumDeclaration

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getEntriesback to summary
public NodeList<EnumConstantDeclaration> getEntries()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getEntryback to summary
public EnumConstantDeclaration getEntry(int i)
getImplementedTypesback to summary
public NodeList<ClassOrInterfaceType> getImplementedTypes()

Implements com.github.javaparser.ast.nodeTypes.NodeWithImplements.getImplementedTypes.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public EnumDeclarationMetaModel getMetaModel()

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

Returns:EnumDeclarationMetaModel

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

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifEnumDeclarationback to summary
public void ifEnumDeclaration(Consumer<EnumDeclaration> action)

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

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

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

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 ResolvedEnumDeclaration resolve()

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

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

Annotations
@Override
setEntriesback to summary
public EnumDeclaration setEntries(final NodeList<EnumConstantDeclaration> entries)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setEntryback to summary
public EnumDeclaration setEntry(int i, EnumConstantDeclaration element)
setImplementedTypesback to summary
public EnumDeclaration setImplementedTypes(final NodeList<ClassOrInterfaceType> implementedTypes)

Implements com.github.javaparser.ast.nodeTypes.NodeWithImplements.setImplementedTypes.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toEnumDeclarationback to summary
public Optional<EnumDeclaration> toEnumDeclaration()

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

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