Statement

java.lang.Object
- cetus.hir.Statement

All Implemented Interfaces:

Annotatable, Printable, Traversable, java.lang.Cloneable

Direct Known Subclasses:

AnnotationStatement, BreakStatement, Case, CompoundStatement, ContinueStatement, DeclarationStatement, Default, DoLoop, ExpressionStatement, ForLoop, GotoStatement, IfStatement, Label, NullStatement, ReturnStatement, SwitchStatement, WhileLoop
```
public abstract class Statement
extends java.lang.Object
implements java.lang.Cloneable, Traversable, Annotatable
```
Base class for all statements. Statement is the base class of numerous specific statement classes.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`annotate(Annotation annotation)` Inserts the given annotation to this statement.
`void`	`annotateAfter(Annotation annotation)` Inserts the given annotation after this statement.
`void`	`annotateBefore(Annotation annotation)` Inserts the given annotation before this statement.
`Statement`	`clone()` Returns a clone of the statement
`boolean`	`containsAnnotation(java.lang.Class<? extends Annotation> type, java.lang.String key)` Checks if this statement contains any annotation with the specified type and the string key.
`void`	`detach()` Detaches this statement from it's parent, if it has one.
`boolean`	`equals(java.lang.Object o)` Compares the statement with the specified object for equality.
`<T extends Annotation> T`	`getAnnotation(java.lang.Class<T> type, java.lang.String key)` Returns the first occurrence of the annotation with the specified type and the string key.
`java.util.List<Annotation>`	`getAnnotations()` Returns the list of annotations attached to this statement.
`<T extends Annotation> java.util.List<T>`	`getAnnotations(java.lang.Class<T> type)` Returns the list of annotations with the specified type, attached to this statement.
`java.util.List<Annotation>`	`getAnnotations(int position)` Returns the list of annotations attached at the specified position of this statement.
`java.util.List<Traversable>`	`getChildren()` Provides access to the children of this object as a list.
`Traversable`	`getParent()` Provides access to the parent of this object.
`Procedure`	`getProcedure()` Returns the procedure in which this statement is located.
`int`	`hashCode()` Returns the hash code of the statement.
`void`	`print(java.io.PrintWriter o)` Prints the statement on the specified print writer.
`void`	`removeAnnotations()` Removes all annotations attached to this statement.
`void`	`removeAnnotations(java.lang.Class<? extends Annotation> type)` Removes all annotations with the specified type.
`void`	`removeChild(Traversable child)` Removes a specific child of this statement; some statements do not support this method.
`void`	`setChild(int index, Traversable t)` Sets the `index`th child of this object to `t`.
`void`	`setLineNumber(int line)` Sets the line number of this statement This function is to be used only for parser development
`void`	`setParent(Traversable t)` Sets the parent of this object.
`void`	`setPrintMethod(java.lang.reflect.Method m)` Overrides the print method for this object only.
`void`	`swapWith(Statement stmt)` Swaps two statements on the IR tree.
`java.lang.String`	`toString()` Returns a string representation of the statement
`void`	`verify()` Verifies three properties of this object: (1) All children are not null, (2) the parent object has this object as a child, (3) all children have this object as the parent.
`int`	`where()` Returns the line number of this statement if the statement was present in the original source file.

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

- Method Detail
  - clone
```
public Statement clone()
```
    Returns a clone of the statement
    
    Overrides:
    
    clone in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compares the statement with the specified object for equality.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    o - the object to be compared.
    
    Returns:
    true if (o == this), false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash code of the statement. It returns the identity hash code of the current statement object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    the identity hash code of the statement.
  - detach
```
public void detach()
```
    Detaches this statement from it's parent, if it has one.
  - getChildren
```
public java.util.List<Traversable> getChildren()
```
    Description copied from interface: Traversable
    
    Provides access to the children of this object as a list. This object is free to internally implement its list as a LinkedList or an ArrayList. It is generally not good practice to call this method yourself; the ordering of children is not guaranteed so instead you should use the methods of the particular class whose children you wish to access.
    
    Specified by:
    
    getChildren in interface Traversable
    
    Returns:
    the children as a list.
  - getParent
```
public Traversable getParent()
```
    Description copied from interface: Traversable
    
    Provides access to the parent of this object. Every IR object has at most one parent. (The parent relationship is the same as the parent relationship in the parse tree, and is not to be confused with the base class of a derived class declaration.)
    
    Specified by:
    
    getParent in interface Traversable
    
    Returns:
    the parent of this object.
  - getProcedure
```
public Procedure getProcedure()
```
    Returns the procedure in which this statement is located.
    
    Returns:
    the procedure in which this statement is located, or null if it is not in a procedure.
  - print
```
public void print(java.io.PrintWriter o)
```
    Prints the statement on the specified print writer.
    
    Specified by:
    
    print in interface Printable
    
    Parameters:
    o - the target print writer.
  - removeChild
```
public void removeChild(Traversable child)
```
    Removes a specific child of this statement; some statements do not support this method.
    
    Specified by:
    
    removeChild in interface Traversable
    
    Parameters:
    child - The child to remove.
  - setChild
```
public void setChild(int index,
            Traversable t)
```
    Description copied from interface: Traversable
    
    Sets the indexth child of this object to t. By calling this method, the old child located at the position i will have a null parent. It is generally not good practice to call this method yourself; the ordering of children is not guaranteed so instead you should use the methods of the particular class whose children you wish to access. There are checks to prevent such actions as making a statement a child of an expression, but you still may be able to do some damage with this method if you are not careful.
    
    Specified by:
    
    setChild in interface Traversable
  - setParent
```
public void setParent(Traversable t)
```
    Description copied from interface: Traversable
    
    Sets the parent of this object. Cetus checks that the parent already considers this object a child. The intent is to maintain an ordering where first this object becomes a child of another object, and then this object is told who its parent is. Enforcing this order makes it easier for Cetus to enforce other invariants and ensure the IR is correct.
    
    Specified by:
    
    setParent in interface Traversable
  - setPrintMethod
```
public void setPrintMethod(java.lang.reflect.Method m)
```
    Overrides the print method for this object only.
    
    Parameters:
    m - The new print method.
  - swapWith
```
public void swapWith(Statement stmt)
```
    Swaps two statements on the IR tree. If neither this statement nor stmt has a parent, then this function has no effect. Otherwise, each statement ends up with the other's parent.
    
    Parameters:
    stmt - The statement with which to swap this statement.
    
    Throws:
    
    java.lang.IllegalArgumentException - if stmt is null.
    
    java.lang.IllegalStateException - if the types of the statements are such that they would create inconsistent IR when swapped.
  - setLineNumber
```
public void setLineNumber(int line)
```
    Sets the line number of this statement This function is to be used only for parser development
    
    Parameters:
    line - The line number
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the statement
    
    Overrides:
    
    toString in class java.lang.Object
  - where
```
public int where()
```
    Returns the line number of this statement if the statement was present in the original source file. Line numbers are not available for statements that are added by compiler passes.
    
    Returns:
    the line number of this statement.
  - verify
```
public void verify()
            throws java.lang.IllegalStateException
```
    Verifies three properties of this object: (1) All children are not null, (2) the parent object has this object as a child, (3) all children have this object as the parent.
    
    Throws:
    
    java.lang.IllegalStateException - if any of the properties are not true.
  - annotate
```
public void annotate(Annotation annotation)
```
    Inserts the given annotation to this statement. The default position of the annotation is before the statement.
    
    Specified by:
    
    annotate in interface Annotatable
    
    Parameters:
    annotation - the annotation to be inserted.
  - annotateAfter
```
public void annotateAfter(Annotation annotation)
```
    Inserts the given annotation after this statement.
    
    Specified by:
    
    annotateAfter in interface Annotatable
    
    Parameters:
    annotation - the annotation to be inserted.
  - annotateBefore
```
public void annotateBefore(Annotation annotation)
```
    Inserts the given annotation before this statement.
    
    Specified by:
    
    annotateBefore in interface Annotatable
    
    Parameters:
    annotation - the annotation to be inserted.
  - getAnnotations
```
public java.util.List<Annotation> getAnnotations()
```
    Returns the list of annotations attached to this statement. It returns the direct handle of the annotation list, so any modifications to the returned list should be carefully done.
    
    Specified by:
    
    getAnnotations in interface Annotatable
    
    Returns:
    the list of attached annotations (null if none exists).
  - getAnnotations
```
public <T extends Annotation> java.util.List<T> getAnnotations(java.lang.Class<T> type)
```
    Returns the list of annotations with the specified type, attached to this statement.
    
    Specified by:
    
    getAnnotations in interface Annotatable
    
    Parameters:
    type - the annotation type of intereset.
    
    Returns:
    the list of annotations with the specified type.
  - containsAnnotation
```
public boolean containsAnnotation(java.lang.Class<? extends Annotation> type,
                         java.lang.String key)
```
    Checks if this statement contains any annotation with the specified type and the string key.
    
    Specified by:
    
    containsAnnotation in interface Annotatable
    
    Parameters:
    type - the annotation type of interest.
    key - the key to be searched for.
    
    Returns:
    the search result.
  - getAnnotation
```
public <T extends Annotation> T getAnnotation(java.lang.Class<T> type,
                                     java.lang.String key)
```
    Returns the first occurrence of the annotation with the specified type and the string key.
    
    Specified by:
    
    getAnnotation in interface Annotatable
    
    Parameters:
    type - the annotation type of interest.
    key - the key to be searched for.
    
    Returns:
    the annotation if one exist, null otherwise.
  - getAnnotations
```
public java.util.List<Annotation> getAnnotations(int position)
```
    Returns the list of annotations attached at the specified position of this statement.
    
    Specified by:
    
    getAnnotations in interface Annotatable
    
    Parameters:
    position - the annotation position to be searched.
    
    Returns:
    the list of annotations with the specified position.
  - removeAnnotations
```
public void removeAnnotations()
```
    Removes all annotations attached to this statement.
    
    Specified by:
    
    removeAnnotations in interface Annotatable
  - removeAnnotations
```
public void removeAnnotations(java.lang.Class<? extends Annotation> type)
```
    Removes all annotations with the specified type.
    
    Specified by:
    
    removeAnnotations in interface Annotatable
    
    Parameters:
    type - the annotation type to be removed.

Class Statement

Method Summary

Methods inherited from class java.lang.Object

Method Detail

clone

equals

hashCode

detach

getChildren

getParent

getProcedure

print

removeChild

setChild

setParent

setPrintMethod

swapWith

setLineNumber

toString

where

verify

annotate

annotateAfter

annotateBefore

getAnnotations

getAnnotations

containsAnnotation

getAnnotation

getAnnotations

removeAnnotations

removeAnnotations