Interface IEnumeratingLoop
-
- All Superinterfaces:
IRuleBlock
- All Known Implementing Classes:
ForStatement,MapExpression
public interface IEnumeratingLoop extends IRuleBlock
Defines the internal interface of an enumerating loop.- Author:
- Holger Eichelberger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IRuleElementdeterminesResult()Returns the body element which determines the result.java.lang.StringgetElementName()Returns the name of the VIL language element.ExpressiongetExpression()Returns the iterator expression.TypeDescriptor<?>getGivenType(int index)Returns the specified given type (further specifying togetVariable(int)).VariableDeclarationgetVariable(int index)Returns the specified variable.intgetVariablesCount()Returns the number of variables defined for this map statement.booleanisColonSeparator()Returns whether the given separator was a colon.-
Methods inherited from interface net.ssehub.easy.instantiation.core.model.buildlangModel.IRuleBlock
addBodyElement, getBodyElement, getBodyElementCount, isVirtual, returnActualValue
-
-
-
-
Method Detail
-
getExpression
Expression getExpression()
Returns the iterator expression.- Returns:
- the iterator expression
-
getVariablesCount
int getVariablesCount()
Returns the number of variables defined for this map statement.- Returns:
- the number of variables
-
getVariable
VariableDeclaration getVariable(int index)
Returns the specified variable.- Parameters:
index- the 0-based index denoting the variable to be returned- Returns:
- the specified variable
- Throws:
java.lang.IndexOutOfBoundsException- in case thatindex < 0 || index >=getVariablesCount()
-
getGivenType
TypeDescriptor<?> getGivenType(int index)
Returns the specified given type (further specifying togetVariable(int)).- Parameters:
index- the 0-based index denoting the type to be returned- Returns:
- the specified type, may be null if not given
- Throws:
java.lang.IndexOutOfBoundsException- in case thatindex < 0 || index >=getVariablesCount()
-
determinesResult
IRuleElement determinesResult()
Returns the body element which determines the result.- Returns:
- the rule element determining the result (may be null if there is none)
-
getElementName
java.lang.String getElementName()
Returns the name of the VIL language element.- Returns:
- the name
-
isColonSeparator
boolean isColonSeparator()
Returns whether the given separator was a colon.- Returns:
trueit it was a colon,elseif it was an equals character
-
-