Class EnumDeclaration

java.lang.Object

com.github.javaparser.ast.Node

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

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

com.github.javaparser.ast.body.EnumDeclaration

All Implemented Interfaces:

NodeWithAccessModifiers<EnumDeclaration>, NodeWithPrivateModifier<EnumDeclaration>, NodeWithProtectedModifier<EnumDeclaration>, NodeWithPublicModifier<EnumDeclaration>, NodeWithStaticModifier<EnumDeclaration>, NodeWithStrictfpModifier<EnumDeclaration>, NodeWithAnnotations<EnumDeclaration>, NodeWithImplements<EnumDeclaration>, NodeWithJavadoc<EnumDeclaration>, NodeWithMembers<EnumDeclaration>, NodeWithModifiers<EnumDeclaration>, NodeWithRange<Node>, NodeWithSimpleName<EnumDeclaration>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, Resolvable<ResolvedEnumDeclaration>, Cloneable

public class EnumDeclaration
extends TypeDeclaration<EnumDeclaration>
implements NodeWithImplements<EnumDeclaration>, Resolvable<ResolvedEnumDeclaration>

The declaration of an enum.
enum X { ... }

Nested Class Summary

Nested classes/interfaces inherited from class Node

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

Field Summary

Fields

Modifier and Type	Field	Description
private NodeList<EnumConstantDeclaration>	entries
private NodeList<ClassOrInterfaceType>	implementedTypes

Fields inherited from class Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
EnumDeclaration()
EnumDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, SimpleName name, NodeList<ClassOrInterfaceType> implementedTypes, NodeList<EnumConstantDeclaration> entries, NodeList<BodyDeclaration<?>> members)
EnumDeclaration(NodeList<Modifier> modifiers, String name)
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 Type	Method	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.
EnumDeclaration	addEntry(EnumConstantDeclaration element)
EnumConstantDeclaration	addEnumConstant(String name)
EnumDeclaration	asEnumDeclaration()
EnumDeclaration	clone()
NodeList<EnumConstantDeclaration>	getEntries()
EnumConstantDeclaration	getEntry(int i)
NodeList<ClassOrInterfaceType>	getImplementedTypes()
EnumDeclarationMetaModel	getMetaModel()
void	ifEnumDeclaration(Consumer<EnumDeclaration> action)
boolean	isEnumDeclaration()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
ResolvedEnumDeclaration	resolve()
EnumDeclaration	setEntries(NodeList<EnumConstantDeclaration> entries)
EnumDeclaration	setEntry(int i, EnumConstantDeclaration element)
EnumDeclaration	setImplementedTypes(NodeList<ClassOrInterfaceType> implementedTypes)
Optional<EnumDeclaration>	toEnumDeclaration()

Methods inherited from class TypeDeclaration

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

Methods inherited from class BodyDeclaration

asAnnotationDeclaration, asAnnotationMemberDeclaration, asCallableDeclaration, asClassOrInterfaceDeclaration, asCompactConstructorDeclaration, asConstructorDeclaration, asEnumConstantDeclaration, asFieldDeclaration, asInitializerDeclaration, asMethodDeclaration, asRecordDeclaration, getAnnotations, ifAnnotationDeclaration, ifAnnotationMemberDeclaration, ifCallableDeclaration, ifClassOrInterfaceDeclaration, ifCompactConstructorDeclaration, ifConstructorDeclaration, ifEnumConstantDeclaration, ifFieldDeclaration, ifInitializerDeclaration, ifMethodDeclaration, ifRecordDeclaration, isAnnotationDeclaration, isAnnotationMemberDeclaration, isCallableDeclaration, isClassOrInterfaceDeclaration, isCompactConstructorDeclaration, isConstructorDeclaration, isEnumConstantDeclaration, isFieldDeclaration, isInitializerDeclaration, isMethodDeclaration, isRecordDeclaration, setAnnotations, toAnnotationDeclaration, toAnnotationMemberDeclaration, toCallableDeclaration, toClassOrInterfaceDeclaration, toCompactConstructorDeclaration, toConstructorDeclaration, toEnumConstantDeclaration, toFieldDeclaration, toInitializerDeclaration, toMethodDeclaration, toRecordDeclaration

Methods inherited from class Node

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

Methods inherited from class Object

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

Methods inherited from interface HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface NodeWithAnnotations

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

Methods inherited from interface NodeWithImplements

addImplementedType, addImplementedType, addImplementedType, addImplements, addImplements, getImplementedTypes, setImplementedType, tryAddImportToParentCompilationUnit

Methods inherited from interface NodeWithJavadoc

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

Methods inherited from interface NodeWithMembers

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

Methods inherited from interface NodeWithModifiers

addModifier, getAccessSpecifier, hasModifier, removeModifier, setModifier, setModifiers

Methods inherited from interface NodeWithPrivateModifier

isPrivate, setPrivate

Methods inherited from interface NodeWithProtectedModifier

isProtected, setProtected

Methods inherited from interface NodeWithPublicModifier

isPublic, setPublic

Methods inherited from interface NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Methods inherited from interface NodeWithSimpleName

getNameAsExpression, getNameAsString, setName

Methods inherited from interface NodeWithStaticModifier

isStatic, setStatic

Methods inherited from interface NodeWithStrictfpModifier

isStrictfp, setStrictfp

Field Details

implementedTypes

private NodeList<ClassOrInterfaceType> implementedTypes

entries

private NodeList<EnumConstantDeclaration> entries

Constructor Details

EnumDeclaration

public EnumDeclaration()

EnumDeclaration

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

EnumDeclaration

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

EnumDeclaration

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 Details

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)

getEntries

public NodeList<EnumConstantDeclaration> getEntries()

getEntry

public EnumConstantDeclaration getEntry(int i)

setEntry

public EnumDeclaration setEntry(int i,
 EnumConstantDeclaration element)

addEntry

public EnumDeclaration addEntry(EnumConstantDeclaration element)

getImplementedTypes

public NodeList<ClassOrInterfaceType> getImplementedTypes()

Specified by:

getImplementedTypes in interface NodeWithImplements<EnumDeclaration>

setEntries

public EnumDeclaration setEntries(NodeList<EnumConstantDeclaration> entries)

setImplementedTypes

public EnumDeclaration setImplementedTypes(NodeList<ClassOrInterfaceType> implementedTypes)

Specified by:

setImplementedTypes in interface NodeWithImplements<EnumDeclaration>

addEnumConstant

public EnumConstantDeclaration addEnumConstant(String name)

remove

public boolean remove(Node node)

Overrides:

remove in class TypeDeclaration<EnumDeclaration>

clone

public EnumDeclaration clone()

Overrides:

clone in class TypeDeclaration<EnumDeclaration>

getMetaModel

public EnumDeclarationMetaModel getMetaModel()

Overrides:

getMetaModel in class TypeDeclaration<EnumDeclaration>

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
 Node replacementNode)

Overrides:

replace in class TypeDeclaration<EnumDeclaration>

isEnumDeclaration

public boolean isEnumDeclaration()

Overrides:

isEnumDeclaration in class BodyDeclaration<EnumDeclaration>

asEnumDeclaration

public EnumDeclaration asEnumDeclaration()

Overrides:

asEnumDeclaration in class BodyDeclaration<EnumDeclaration>

ifEnumDeclaration

public void ifEnumDeclaration(Consumer<EnumDeclaration> action)

Overrides:

ifEnumDeclaration in class BodyDeclaration<EnumDeclaration>

resolve

public ResolvedEnumDeclaration resolve()

Specified by:

resolve in interface Resolvable<ResolvedEnumDeclaration>

Specified by:

resolve in class TypeDeclaration<EnumDeclaration>

toEnumDeclaration

public Optional<EnumDeclaration> toEnumDeclaration()

Overrides:

toEnumDeclaration in class BodyDeclaration<EnumDeclaration>