de.uka.ilkd.key.java.statement

Class EnhancedFor

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

de.uka.ilkd.key.java.JavaNonTerminalProgramElement

de.uka.ilkd.key.java.statement.JavaStatement

de.uka.ilkd.key.java.statement.LoopStatement

de.uka.ilkd.key.java.statement.EnhancedFor

All Implemented Interfaces:

ExpressionContainer, ModelElement, NonTerminalProgramElement, ProgramElement, ScopeDefiningElement, SourceElement, Statement, StatementContainer, VariableScope, SVSubstitute

public class EnhancedFor
extends LoopStatement
implements VariableScope

The new enhanced form of a for-loop. for(Type var : exp) Statement LoopStatement.inits is initialized with "Type var" LoopStatement.guard is initialized with "exp" LoopStatement.body with "statement"

Author:

mulbrich

Field Summary

Fields inherited from class de.uka.ilkd.key.java.statement.LoopStatement

body, guard, inits, updates

Constructor Summary

Constructors

Constructor and Description
EnhancedFor() create empty for loop.
EnhancedFor(ExtList children) Used by the CreatingASTVisitor.
EnhancedFor(LoopInit init, Guard guard, Statement statement, ExtList comments, PositionInfo info) Used for the Recoder2KeY transformation.

Method Summary

Modifier and Type	Method and Description
SourceElement	getLastElement() Finds the source element that occurs last in the source.
LocalVariableDeclaration	getVariableDeclaration() get the local variable declaration of the enhanced for-loop for(type var : exp) gives type var.
boolean	isCheckedBeforeIteration() Is checked before iteration.
void	prettyPrint(PrettyPrinter p) Pretty printing the source element.
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Methods inherited from class de.uka.ilkd.key.java.statement.LoopStatement

equals, getBody, getChildAt, getChildCount, getExpressionAt, getExpressionCount, getGuard, getGuardExpression, getIForUpdates, getILoopInit, getInitializers, getStatementAt, getStatementCount, getUpdates

Methods inherited from class de.uka.ilkd.key.java.JavaNonTerminalProgramElement

compatibleBlockSize, computeHashCode, equalsModRenaming, getArrayPos, match, matchChildren

Methods inherited from class de.uka.ilkd.key.java.JavaProgramElement

getComments, hashCode, prettyPrintMain, reuseSignature

Methods inherited from class de.uka.ilkd.key.java.JavaSourceElement

getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getParentClass, getPositionInfo, getRelativePosition, getStartPosition, setParentClass, toSource, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.uka.ilkd.key.java.NonTerminalProgramElement

getChildAt, getChildCount

Methods inherited from interface de.uka.ilkd.key.java.ProgramElement

getComments, match

Methods inherited from interface de.uka.ilkd.key.java.SourceElement

equalsModRenaming, getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getPositionInfo, getRelativePosition, getStartPosition

Constructor Detail

EnhancedFor

public EnhancedFor()

create empty for loop.

EnhancedFor

public EnhancedFor(LoopInit init,
                   Guard guard,
                   Statement statement,
                   ExtList comments,
                   PositionInfo info)

Used for the Recoder2KeY transformation.

Parameters:

init - the initializers - here a single VariableDeclaration. may not be null.

guard - a guard - here an expression of type Iterable. may not be null.

statement - the statement of the loop

comments - collected comments

info - position

EnhancedFor

public EnhancedFor(ExtList children)

Used by the CreatingASTVisitor.

Parameters:

children - a list of parameters

Method Detail

getLastElement

public SourceElement getLastElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs last in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getLastElement in interface SourceElement

Overrides:

getLastElement in class JavaSourceElement

Returns:

the last source element in the syntactical representation of this element, may be equals to this element.

See Also:

For.getLastElement(), JavaSourceElement.getLastElement()

isCheckedBeforeIteration

public boolean isCheckedBeforeIteration()

Description copied from class: LoopStatement

Is checked before iteration.

Specified by:

isCheckedBeforeIteration in class LoopStatement

Returns:

the boolean value.

See Also:

For.isCheckedBeforeIteration(), LoopStatement.isCheckedBeforeIteration()

visit

public void visit(Visitor v)

Description copied from interface: SourceElement

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Specified by:

visit in interface SourceElement

Parameters:

v - the Visitor

prettyPrint

public void prettyPrint(PrettyPrinter p)
                 throws java.io.IOException

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class JavaProgramElement

Parameters:

p - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.

getVariableDeclaration

public LocalVariableDeclaration getVariableDeclaration()

get the local variable declaration of the enhanced for-loop for(type var : exp) gives type var.

Returns:

the local variable declaration.