zserio.ast

Class ChoiceType

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocumentableAstNode

zserio.ast.CompoundType

zserio.ast.ChoiceType

All Implemented Interfaces:

AstNode, PackageSymbol, ZserioScopedType, ZserioTemplatableType, ZserioType

public final class ChoiceType
extends CompoundType

AST node for Choice types. Choice types are Zserio types as well.

Constructor Summary

Constructors

Constructor and Description
ChoiceType(AstLocation location, Package pkg, java.lang.String name, java.util.List<TemplateParameter> templateParameters, java.util.List<Parameter> typeParameters, Expression selectorExpression, java.util.List<ChoiceCase> choiceCases, ChoiceDefault choiceDefault, java.util.List<Function> functions, java.util.List<DocComment> docComments) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
java.util.List<ChoiceCase>	getChoiceCases() Gets list of choice cases defined by the choice.
ChoiceDefault	getChoiceDefault() Gets default case defined by the choice.
java.lang.String	getInstantiationName() Gets the unique instantiation name.
java.util.ArrayDeque<TypeReference>	getInstantiationReferenceStack() Gets stack of instantiations leading to this instantiation.
java.util.List<ZserioTemplatableType>	getInstantiations() Gets all template's instantiations.
java.util.ArrayDeque<TypeReference>	getReversedInstantiationReferenceStack() Gets reversed stack of instantiations leading to this instantiation.
Expression	getSelectorExpression() Gets selector expression.
ZserioTemplatableType	getTemplate() Gets original template used for instantiation.
java.util.List<TemplateParameter>	getTemplateParameters() Gets list of template parameters.
protected boolean	hasBranchWithoutImplicitArray()
protected boolean	hasEmptyBranch(boolean implicitCanBeEmpty)
boolean	isChoiceDefaultUnreachable() Checks if default case in choice can happen.
void	visitChildren(ZserioAstVisitor visitor) Visit children of the current AST node using given visitor.

Methods inherited from class zserio.ast.CompoundType

checkNonSqlTableFields, checkSqlSymbolNames, checkSqlTableFields, checkSymbolNames, containsExtendedField, getFields, getFunctions, getName, getPackage, getScope, getTypeParameters, hasFieldBranchWithoutImplicitArray, hasFieldEmptyBranch, hasPackableField, isPackable, needsChildrenInitialization, trackExtendedField, trackImplicitArray

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

ChoiceType

public ChoiceType(AstLocation location,
                  Package pkg,
                  java.lang.String name,
                  java.util.List<TemplateParameter> templateParameters,
                  java.util.List<Parameter> typeParameters,
                  Expression selectorExpression,
                  java.util.List<ChoiceCase> choiceCases,
                  ChoiceDefault choiceDefault,
                  java.util.List<Function> functions,
                  java.util.List<DocComment> docComments)

Constructor.

Parameters:

location - AST node location.

pkg - Package to which belongs the choice type.

name - Name of the choice type.

templateParameters - List of template parameters.

typeParameters - List of parameters for the choice type.

selectorExpression - Selector expression of the choice type.

choiceCases - List of all choice cases.

choiceDefault - Choice default case or null if default case is not defined.

functions - List of all functions of the choice type.

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.

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 CompoundType

Parameters:

visitor - Visitor to use.

getSelectorExpression

public Expression getSelectorExpression()

Gets selector expression. Selector expression is compulsory for choice types, therefore this method cannot return null.

Returns:

Returns expressions which is given as choice selector.

getChoiceCases

public java.util.List<ChoiceCase> getChoiceCases()

Gets list of choice cases defined by the choice.

Returns:

List of choice cases.

getChoiceDefault

public ChoiceDefault getChoiceDefault()

Gets default case defined by the choice.

Returns:

Default case or null if default case is not defined.

isChoiceDefaultUnreachable

public boolean isChoiceDefaultUnreachable()

Checks if default case in choice can happen. Actually, only boolean choices can have default case unreachable. This can happen only if the boolean choice has defined both cases (true and false).

Returns:

Returns true if default case is unreachable.

hasBranchWithoutImplicitArray

protected boolean hasBranchWithoutImplicitArray()

Overrides:

hasBranchWithoutImplicitArray in class CompoundType

hasEmptyBranch

protected boolean hasEmptyBranch(boolean implicitCanBeEmpty)

Overrides:

hasEmptyBranch in class CompoundType

getTemplateParameters

public java.util.List<TemplateParameter> getTemplateParameters()

Description copied from interface: ZserioTemplatableType

Gets list of template parameters.

Specified by:

getTemplateParameters in interface ZserioTemplatableType

Returns:

List of template parameters.

getInstantiations

public java.util.List<ZserioTemplatableType> getInstantiations()

Description copied from interface: ZserioTemplatableType

Gets all template's instantiations.

Specified by:

getInstantiations in interface ZserioTemplatableType

Returns:

List of all instantiations.

getTemplate

public ZserioTemplatableType getTemplate()

Description copied from interface: ZserioTemplatableType

Gets original template used for instantiation.

Specified by:

getTemplate in interface ZserioTemplatableType

Returns:

Template of the current instantiation or null when this is not an instantiation.

getInstantiationReferenceStack

public java.util.ArrayDeque<TypeReference> getInstantiationReferenceStack()

Description copied from interface: ZserioTemplatableType

Gets stack of instantiations leading to this instantiation.

Specified by:

getInstantiationReferenceStack in interface ZserioTemplatableType

Returns:

Stack of type references.

getReversedInstantiationReferenceStack

public java.util.ArrayDeque<TypeReference> getReversedInstantiationReferenceStack()

Description copied from interface: ZserioTemplatableType

Gets reversed stack of instantiations leading to this instantiation.

Specified by:

getReversedInstantiationReferenceStack in interface ZserioTemplatableType

Returns:

Stack of type references.

getInstantiationName

public java.lang.String getInstantiationName()

Description copied from interface: ZserioTemplatableType

Gets the unique instantiation name.

Specified by:

getInstantiationName in interface ZserioTemplatableType

Returns:

Instantiation name unique in the package where template is located.