zserio.ast

Class Field

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocumentableAstNode

zserio.ast.Field

All Implemented Interfaces:

AstNode, ScopeSymbol

public final class Field
extends DocumentableAstNode
implements ScopeSymbol

AST node for compound fields. This field is used by all Compound types (structure types, choice types, ...).

Constructor Summary

Constructors

Constructor and Description
Field(AstLocation location, boolean isExtended, TypeInstantiation typeInstantiation, java.lang.String name, boolean isAutoOptional, Expression alignmentExpr, Expression offsetExpr, Expression initializerExpr, Expression optionalClauseExpr, Expression constraintExpr, java.util.List<DocComment> docComments) Constructor from Structure types.
Field(AstLocation location, TypeInstantiation fieldTypeInstantiation, java.lang.String name, boolean isVirtual, SqlConstraint sqlConstraint, java.util.List<DocComment> docComments) Constructor from SQL Table types.
Field(AstLocation location, TypeInstantiation fieldTypeInstantiation, java.lang.String name, Expression constraintExpr, java.util.List<DocComment> docComments) Constructor from Choice and Union types.
Field(AstLocation location, TypeInstantiation fieldTypeInstantiation, java.lang.String name, java.util.List<DocComment> docComments) Constructor from SQL Database types.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
Expression	getAlignmentExpr() Gets alignment expression associated with the field.
Expression	getConstraintExpr() Gets constraint expression associated with the field.
Expression	getInitializerExpr() Gets initializer expression associated with the field.
java.lang.String	getName() Gets the name of the symbol stored in the lexical scope.
Expression	getOffsetExpr() Gets offset expression associated with the field.
Expression	getOptionalClauseExpr() Gets optional clause expression associated with the field.
SqlConstraint	getSqlConstraint() Gets SQL constraint associated with the field.
TypeInstantiation	getTypeInstantiation() Gets the field's type instantiation.
boolean	isExtended() Gets flag which indicates if the field has been defined using "extend" keyword in Zserio.
boolean	isOptional() Gets flag which indicates if the field is optional.
boolean	isPackable() Gets flag which indicates if the field is is packable.
boolean	isVirtual() Gets flag which indicates if the field has been defined using "sql_virtual" keyword in Zserio.
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

Field

public Field(AstLocation location,
             boolean isExtended,
             TypeInstantiation typeInstantiation,
             java.lang.String name,
             boolean isAutoOptional,
             Expression alignmentExpr,
             Expression offsetExpr,
             Expression initializerExpr,
             Expression optionalClauseExpr,
             Expression constraintExpr,
             java.util.List<DocComment> docComments)

Constructor from Structure types.

Parameters:

location - AST node location.

isExtended - Whether the field is defined using the 'extend' keyword.

typeInstantiation - Field type instantiation.

name - Field name.

isAutoOptional - Auto optional flag.

alignmentExpr - Alignment expression or null if it's not defined.

offsetExpr - Offset expression or null if it's not defined.

initializerExpr - Initializer expression or null if it's not defined.

optionalClauseExpr - Optional clause expression or null if it's not defined.

constraintExpr - Constraint expression or null if it's not defined.

docComments - List of documentation comments belonging to this node.

Field

public Field(AstLocation location,
             TypeInstantiation fieldTypeInstantiation,
             java.lang.String name,
             Expression constraintExpr,
             java.util.List<DocComment> docComments)

Constructor from Choice and Union types.

Parameters:

location - AST node location.

fieldTypeInstantiation - Field type instantiation.

name - Field name.

constraintExpr - Constraint expression or null if it's not defined.

docComments - List of documentation comments belonging to this node.

Field

public Field(AstLocation location,
             TypeInstantiation fieldTypeInstantiation,
             java.lang.String name,
             boolean isVirtual,
             SqlConstraint sqlConstraint,
             java.util.List<DocComment> docComments)

Constructor from SQL Table types.

Parameters:

location - AST node location.

fieldTypeInstantiation - Field type instantiation.

name - Field name.

isVirtual - True if field is virtual.

sqlConstraint - SQL constraint or null if it's not defined.

docComments - List of documentation comments belonging to this node.

Field

public Field(AstLocation location,
             TypeInstantiation fieldTypeInstantiation,
             java.lang.String name,
             java.util.List<DocComment> docComments)

Constructor from SQL Database types.

Parameters:

location - AST node location.

fieldTypeInstantiation - Field type instantiation.

name - Field name.

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.

isExtended

public boolean isExtended()

Gets flag which indicates if the field has been defined using "extend" keyword in Zserio.

Returns:

True when the field is extended.

getTypeInstantiation

public TypeInstantiation getTypeInstantiation()

Gets the field's type instantiation.

Returns:

Type instantiation.

getAlignmentExpr

public Expression getAlignmentExpr()

Gets alignment expression associated with the field.

Returns:

Alignment expression or null if no alignment expression has been specified.

getOffsetExpr

public Expression getOffsetExpr()

Gets offset expression associated with the field.

Returns:

Offset expression or null if no offset expression has been specified.

getInitializerExpr

public Expression getInitializerExpr()

Gets initializer expression associated with the field.

Returns:

Initializer expression or null if no initializer expression has been specified.

getOptionalClauseExpr

public Expression getOptionalClauseExpr()

Gets optional clause expression associated with the field.

Returns:

Optional clause expression or null if no optional clause expression has been specified.

getConstraintExpr

public Expression getConstraintExpr()

Gets constraint expression associated with the field.

Returns:

Constraint expression or null if no constraint expression has been specified.

getSqlConstraint

public SqlConstraint getSqlConstraint()

Gets SQL constraint associated with the field.

Returns:

SQL constraint or null if no SQL constraint has been specified.

isVirtual

public boolean isVirtual()

Gets flag which indicates if the field has been defined using "sql_virtual" keyword in Zserio.

Returns:

true if the field is virtual column in SQL table.

isOptional

public boolean isOptional()

Gets flag which indicates if the field is optional.

Returns:

True if the field has been defined using "optional" keyword in Zserio or if the field has optional clause.

isPackable

public boolean isPackable()

Gets flag which indicates if the field is is packable. Currently this is true for integral fields and also for all compounds which have at least one packable field. It is also true for arrays of such types.

Returns:

True if the field is packable.