zserio.ast

Class EnumItem

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocumentableAstNode

zserio.ast.EnumItem

All Implemented Interfaces:

AstNode, ScopeSymbol

public final class EnumItem
extends DocumentableAstNode
implements ScopeSymbol

AST node for items defined by enumeration types.

Constructor Summary

Constructors

Constructor and Description
EnumItem(AstLocation location, java.lang.String name, Expression valueExpression, boolean isDeprecated, boolean isRemoved, java.util.List<DocComment> docComments) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
java.lang.String	getName() Gets the name of the symbol stored in the lexical scope.
java.math.BigInteger	getValue() Gets the integer value which represents the enumeration item.
Expression	getValueExpression() Gets enumeration item value expression.
boolean	isDeprecated() Gets whether this enumeration item is deprecated.
boolean	isRemoved() Gets whether this enumeration item is removed.
void	visitChildren(ZserioAstVisitor visitor) Visit children of the current AST node using given visitor.

Methods inherited from class zserio.ast.DocumentableAstNode

getDocComments

Methods inherited from class zserio.ast.AstNodeBase

getLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface zserio.ast.AstNode

getLocation

Constructor Detail

EnumItem

public EnumItem(AstLocation location,
                java.lang.String name,
                Expression valueExpression,
                boolean isDeprecated,
                boolean isRemoved,
                java.util.List<DocComment> docComments)

Constructor.

Parameters:

location - AST node location.

name - Name of the enumeration item.

valueExpression - Expression value of the enumeration item.

isDeprecated - Flag whether this enum item is marked as deprecated.

isRemoved - Flag whether this enum item is marked as removed.

docComments - List of documentation comments belonging to this node.

Method Detail

accept

public void accept(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Accept zserio visitor.

Specified by:

accept in interface AstNode

Parameters:

visitor - Visitor to accept.

visitChildren

public void visitChildren(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Visit children of the current AST node using given visitor.

Specified by:

visitChildren in interface AstNode

Overrides:

visitChildren in class DocumentableAstNode

Parameters:

visitor - Visitor to use.

getName

public java.lang.String getName()

Description copied from interface: ScopeSymbol

Gets the name of the symbol stored in the lexical scope.

Specified by:

getName in interface ScopeSymbol

Returns:

Name of the symbol.

getValueExpression

public Expression getValueExpression()

Gets enumeration item value expression.

Returns:

Enumeration item value expression or null if value expression has not been specified.

getValue

public java.math.BigInteger getValue()

Gets the integer value which represents the enumeration item.

Returns:

Returns the integer value of the enumeration item.

isDeprecated

public boolean isDeprecated()

Gets whether this enumeration item is deprecated.

Returns:

Returns true when this item is deprecated, false otherwise.

isRemoved

public boolean isRemoved()

Gets whether this enumeration item is removed.

Returns:

Returns true when this item is removed, false otherwise.