WhileLoop

java.lang.Object
- cetus.hir.Statement
- - cetus.hir.WhileLoop

All Implemented Interfaces:

Annotatable, Loop, Printable, SymbolTable, Traversable, java.lang.Cloneable
```
public class WhileLoop
extends Statement
implements Loop, SymbolTable
```
WhileLoop represents a while loop having a condition expression and a loop body.

Constructor Summary

Constructors
Constructor and Description
`WhileLoop(Expression condition, Statement body)` Constructs a new while loop with the given condition expression condition and the loop body body.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDeclaration(Declaration decl)` Add a declaration to the end of the set of declarations and place the declared symbols in the symbol table.
`void`	`addDeclarationAfter(Declaration ref, Declaration decl)` Add a declaration after the reference declaration.
`void`	`addDeclarationBefore(Declaration ref, Declaration decl)` Add a declaration before the reference declaration.
`WhileLoop`	`clone()` Returns a clone of this while loop.
`boolean`	`containsDeclaration(Declaration decl)` Checks if the symbol table contains the specified declaration.
`boolean`	`containsSymbol(Symbol symbol)` Checks if the symbol table contains the specified symbol.
`static void`	`defaultPrint(WhileLoop l, java.io.PrintWriter o)` Prints a loop to a stream.
`Declaration`	`findSymbol(IDExpression name)` Retrieves the declaration for a symbol, possibly searching through parent symbol tables.
`Statement`	`getBody()` Returns the statement that is the body of the loop.
`Expression`	`getCondition()` Returns the expression that determines the duration of the loop.
`java.util.Set<Declaration>`	`getDeclarations()` Returns the set of declarations declared within the symbol table object.
`java.util.List<SymbolTable>`	`getParentTables()` Returns a list of symbol tables that are parents of this table in the distributed symbol table graph.
`java.util.Set<Symbol>`	`getSymbols()` Returns the set of declared symbols in the symbol table object.
`void`	`setBody(Statement body)` Sets the body statement with the given statement body.
`static void`	`setClassPrintMethod(java.lang.reflect.Method m)` Overrides the class print method, so that all subsequently created objects will use the supplied method.
`void`	`setCondition(Expression cond)` Sets the condition expression with the given expression cond.

Methods inherited from class cetus.hir.Statement
annotate, annotateAfter, annotateBefore, containsAnnotation, detach, equals, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getChildren, getParent, getProcedure, hashCode, print, removeAnnotations, removeAnnotations, removeChild, setChild, setLineNumber, setParent, setPrintMethod, swapWith, toString, verify, where

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cetus.hir.Traversable
getChildren, getParent, removeChild, setChild, setParent

Methods inherited from interface cetus.hir.Printable
print

- Constructor Detail
  - WhileLoop
```
public WhileLoop(Expression condition,
         Statement body)
```
    Constructs a new while loop with the given condition expression condition and the loop body body. Any non-compound statement body is normalized to a compound statement.
    
    Parameters:
    condition - the condition expression.
    body - the body statement.
    
    Throws:
    
    java.lang.IllegalArgumentException - if condition or body is null.
    
    NotAnOrphanException - if condition or body has a parent.
- Method Detail
  - addDeclaration
```
public void addDeclaration(Declaration decl)
```
    Description copied from interface: SymbolTable
    
    Add a declaration to the end of the set of declarations and place the declared symbols in the symbol table.
    
    Specified by:
    
    addDeclaration in interface SymbolTable
    
    Parameters:
    decl - The declaration to add.
  - addDeclarationBefore
```
public void addDeclarationBefore(Declaration ref,
                        Declaration decl)
```
    Description copied from interface: SymbolTable
    
    Add a declaration before the reference declaration.
    
    Specified by:
    
    addDeclarationBefore in interface SymbolTable
    
    Parameters:
    ref - The reference point.
    decl - The declaration to add.
  - addDeclarationAfter
```
public void addDeclarationAfter(Declaration ref,
                       Declaration decl)
```
    Description copied from interface: SymbolTable
    
    Add a declaration after the reference declaration.
    
    Specified by:
    
    addDeclarationAfter in interface SymbolTable
    
    Parameters:
    ref - The reference point.
    decl - The declaration to add.
  - defaultPrint
```
public static void defaultPrint(WhileLoop l,
                java.io.PrintWriter o)
```
    Prints a loop to a stream.
    
    Parameters:
    l - The loop to print.
    o - The writer on which to print the loop.
  - findSymbol
```
public Declaration findSymbol(IDExpression name)
```
    Description copied from interface: SymbolTable
    
    Retrieves the declaration for a symbol, possibly searching through parent symbol tables.
    
    Specified by:
    
    findSymbol in interface SymbolTable
    
    Parameters:
    name - The name of the symbol.
  - getBody
```
public Statement getBody()
```
    Description copied from interface: Loop
    
    Returns the statement that is the body of the loop.
    
    Specified by:
    
    getBody in interface Loop
    
    Returns:
    the body of the loop.
  - setBody
```
public void setBody(Statement body)
```
    Sets the body statement with the given statement body. Any non-compound statement is normalized to a compound statement.
    
    Parameters:
    body - the new body statement.
    
    Throws:
    
    java.lang.IllegalArgumentException - if body is null.
    
    NotAnOrphanException - if body has a parent object.
  - getCondition
```
public Expression getCondition()
```
    Description copied from interface: Loop
    
    Returns the expression that determines the duration of the loop.
    
    Specified by:
    
    getCondition in interface Loop
    
    Returns:
    the condition that is tested each iteration.
  - setCondition
```
public void setCondition(Expression cond)
```
    Sets the condition expression with the given expression cond.
    
    Parameters:
    cond - the new condition expression.
    
    Throws:
    
    java.lang.IllegalArgumentException - if cond is null.
    
    NotAnOrphanException - if cond has a parent object.
  - getParentTables
```
public java.util.List<SymbolTable> getParentTables()
```
    Description copied from interface: SymbolTable
    
    Returns a list of symbol tables that are parents of this table in the distributed symbol table graph. A list is necessary because representing multiple inheritence in C++ requires it. Note that the parent tables are not necessarily tables of the immediate parent. The list is all symbol tables enclosing this object which appear at the same level such that no other symbol tables appear between this object and those tables.
    
    Specified by:
    
    getParentTables in interface SymbolTable
    
    Returns:
    a List of SymbolTables.
  - setClassPrintMethod
```
public static void setClassPrintMethod(java.lang.reflect.Method m)
```
    Overrides the class print method, so that all subsequently created objects will use the supplied method.
    
    Parameters:
    m - The new print method.
  - clone
```
public WhileLoop clone()
```
    Returns a clone of this while loop.
    
    Overrides:
    
    clone in class Statement
  - getSymbols
```
public java.util.Set<Symbol> getSymbols()
```
    Description copied from interface: SymbolTable
    
    Returns the set of declared symbols in the symbol table object.
    
    Specified by:
    
    getSymbols in interface SymbolTable
    
    Returns:
    the set of declared symbols.
  - getDeclarations
```
public java.util.Set<Declaration> getDeclarations()
```
    Description copied from interface: SymbolTable
    
    Returns the set of declarations declared within the symbol table object.
    
    Specified by:
    
    getDeclarations in interface SymbolTable
    
    Returns:
    the set of declarations within the symbol table object.
  - containsSymbol
```
public boolean containsSymbol(Symbol symbol)
```
    Description copied from interface: SymbolTable
    
    Checks if the symbol table contains the specified symbol.
    
    Specified by:
    
    containsSymbol in interface SymbolTable
    
    Returns:
    true if the symbol table contains symbol.
  - containsDeclaration
```
public boolean containsDeclaration(Declaration decl)
```
    Description copied from interface: SymbolTable
    
    Checks if the symbol table contains the specified declaration.
    
    Specified by:
    
    containsDeclaration in interface SymbolTable
    
    Returns:
    true if the symbol table contains decl.

Class WhileLoop

Constructor Summary

Method Summary

Methods inherited from class cetus.hir.Statement

Methods inherited from class java.lang.Object

Methods inherited from interface cetus.hir.Traversable

Methods inherited from interface cetus.hir.Printable

Constructor Detail

WhileLoop

Method Detail

addDeclaration

addDeclarationBefore

addDeclarationAfter

defaultPrint

findSymbol

getBody

setBody

getCondition

setCondition

getParentTables

setClassPrintMethod

clone

getSymbols

getDeclarations

containsSymbol

containsDeclaration