Package net.ssehub.easy.instantiation.core.model.buildlangModel

Class ForStatement

java.lang.Object

net.ssehub.easy.instantiation.core.model.buildlangModel.ProjectElement

net.ssehub.easy.instantiation.core.model.buildlangModel.RuleBlock

net.ssehub.easy.instantiation.core.model.buildlangModel.ForStatement

All Implemented Interfaces:

IBuildlangElement, IEnumeratingLoop, IRuleBlock, IRuleElement, ILanguageElement

public class ForStatement
extends RuleBlock
implements IRuleElement, IEnumeratingLoop

Implements a VIL for statement.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	colon
private Expression	expr
private TypeDescriptor<?>[]	givenTypes
private VariableDeclaration[]	variables

Constructor Summary

Constructors

Constructor	Description
ForStatement(VariableDeclaration[] variables, Expression expr, IRuleElement[] body, TypeDescriptor<?>[] givenTypes, boolean colon)	Creates a for statement.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(IVisitor visitor)	Accepts the visitor for visiting.
IRuleElement	determinesResult()	Returns the body element which determines the result.
java.lang.String	getElementName()	Returns the name of the VIL language element.
Expression	getExpression()	Returns the iterator expression.
TypeDescriptor<?>	getGivenType(int index)	Returns the specified given type (further specifying to IEnumeratingLoop.getVariable(int)).
VariableDeclaration	getVariable(int index)	Returns the specified variable.
int	getVariablesCount()	Returns the number of variables defined for this map statement.
boolean	isColonSeparator()	Returns whether the given separator was a colon.
boolean	isVirtual()	Returns whether this block is a real block or consists just of a block element without brackets.
boolean	returnActualValue()	Returns whether this body shall return an actual value (function) or a rule execution result.
protected void	setParent(ILanguageElement parent)	Changes the parent.

Methods inherited from class net.ssehub.easy.instantiation.core.model.buildlangModel.RuleBlock

addBodyElement, addBodyElement, append, getBodyElement, getBodyElementCount, setBody

Methods inherited from class net.ssehub.easy.instantiation.core.model.buildlangModel.ProjectElement

getName, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ssehub.easy.instantiation.core.model.common.ILanguageElement

getParent

Methods inherited from interface net.ssehub.easy.instantiation.core.model.buildlangModel.IRuleBlock

addBodyElement, getBodyElement, getBodyElementCount

Field Detail

variables

private VariableDeclaration[] variables

expr

private Expression expr

givenTypes

private TypeDescriptor<?>[] givenTypes

colon

private boolean colon

Constructor Detail

ForStatement

public ForStatement(VariableDeclaration[] variables,
                    Expression expr,
                    IRuleElement[] body,
                    TypeDescriptor<?>[] givenTypes,
                    boolean colon)
             throws VilException

Creates a for statement.

Parameters:

variables - the variables to iterate over

expr - the expression denoting on what to iterate

body - the body of the for statement

givenTypes - the given types in addition to the inferred types of the variable (may be null; if given must have same length as variables, may contain null if no type is given, types must at least be supertypes of those in variables)

colon - true it it was a colon, else if it was an equals character

Throws:

VilException - in case of initialization problems

Method Detail

getVariablesCount

public int getVariablesCount()

Description copied from interface: IEnumeratingLoop

Returns the number of variables defined for this map statement.

Specified by:

getVariablesCount in interface IEnumeratingLoop

Returns:

the number of variables

getVariable

public VariableDeclaration getVariable(int index)

Description copied from interface: IEnumeratingLoop

Returns the specified variable.

Specified by:

getVariable in interface IEnumeratingLoop

Parameters:

index - the 0-based index denoting the variable to be returned

Returns:

the specified variable

getGivenType

public TypeDescriptor<?> getGivenType(int index)

Description copied from interface: IEnumeratingLoop

Returns the specified given type (further specifying to IEnumeratingLoop.getVariable(int)).

Specified by:

getGivenType in interface IEnumeratingLoop

Parameters:

index - the 0-based index denoting the type to be returned

Returns:

the specified type, may be null if not given

getExpression

public Expression getExpression()

Description copied from interface: IEnumeratingLoop

Returns the iterator expression.

Specified by:

getExpression in interface IEnumeratingLoop

Returns:

the iterator expression

accept

public java.lang.Object accept(IVisitor visitor)
                        throws VilException

Description copied from interface: IBuildlangElement

Accepts the visitor for visiting.

Specified by:

accept in interface IBuildlangElement

Parameters:

visitor - the visitor to be used

Returns:

the result of visiting this instance (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

isColonSeparator

public boolean isColonSeparator()

Returns whether the given separator was a colon.

Specified by:

isColonSeparator in interface IEnumeratingLoop

Returns:

true it it was a colon, else if it was an equals character

isVirtual

public boolean isVirtual()

Description copied from interface: IRuleBlock

Returns whether this block is a real block or consists just of a block element without brackets.

Specified by:

isVirtual in interface IRuleBlock

Returns:

true if this block is virtual, false else

determinesResult

public IRuleElement determinesResult()

Description copied from interface: IEnumeratingLoop

Returns the body element which determines the result.

Specified by:

determinesResult in interface IEnumeratingLoop

Returns:

the rule element determining the result (may be null if there is none)

getElementName

public java.lang.String getElementName()

Description copied from interface: IEnumeratingLoop

Returns the name of the VIL language element.

Specified by:

getElementName in interface IEnumeratingLoop

Returns:

the name

returnActualValue

public boolean returnActualValue()

Description copied from interface: IRuleBlock

Returns whether this body shall return an actual value (function) or a rule execution result.

Specified by:

returnActualValue in interface IRuleBlock

Returns:

true in case of an actual value, false else

setParent

protected void setParent(ILanguageElement parent)

Description copied from class: ProjectElement

Changes the parent. Please override if children must be adjusted according. Shall be called only once per instance, but there is no limitation.

Overrides:

setParent in class RuleBlock

Parameters:

parent - the parent