Declaration

java.lang.Object
- cetus.hir.Declaration

All Implemented Interfaces:

Annotatable, Printable, Traversable, java.lang.Cloneable

Direct Known Subclasses:

AccessLevel, AnnotationDeclaration, ClassDeclaration, Enumeration, LinkageSpecification, Namespace, NamespaceAlias, PreAnnotation, Procedure, TemplateDeclaration, UsingDeclaration, UsingDirective, VariableDeclaration
```
public abstract class Declaration
extends java.lang.Object
implements java.lang.Cloneable, Traversable, Annotatable
```
Base class for all declarations. Every declaration object should have a SymbolTable object that defines the scope, as an ancestor node in the IR tree; TranslationUnit and CompoundStatement are the two typical symbol table objects. It is highly recommended to use the high-level interface methods of SymbolTable, not the low-level methods of Traversable, for consistent management of symbol table features.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`annotate(Annotation annotation)` Inserts the given annotation to this declaration.
`void`	`annotateAfter(Annotation annotation)` Inserts the given annotation after this declaration.
`void`	`annotateBefore(Annotation annotation)` Inserts the given annotation before this declaration.
`Declaration`	`clone()` Creates and returns a deep copy of this declaration.
`boolean`	`containsAnnotation(java.lang.Class<? extends Annotation> type, java.lang.String key)` Checks if this declaration contains any annotation with the specified type and the string key.
`void`	`detach()` Detaches this declaration from it's parent, if it has one.
`boolean`	`equals(java.lang.Object o)` Checks if the declaration is equal to the given object.
`<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 declaration.
`<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 declaration.
`java.util.List<Annotation>`	`getAnnotations(int position)` Returns the list of annotations attached at the specified position of this declaration.
`java.util.List<Traversable>`	`getChildren()` Provides access to the children of this object as a list.
`abstract java.util.List<IDExpression>`	`getDeclaredIDs()` Returns a list of name ID introduced by this declaration.
`Traversable`	`getParent()` Provides access to the parent of this object.
`int`	`hashCode()` Returns the hash code of the declaration.
`void`	`print(java.io.PrintWriter o)` Prints this declaration to the specified print writer.
`void`	`removeAnnotations()` Removes all annotations attached to this declaration.
`void`	`removeAnnotations(java.lang.Class<? extends Annotation> type)` Removes all annotations with the specified type.
`void`	`removeChild(Traversable child)` This operation is not allowed.
`void`	`setChild(int index, Traversable t)` Sets the `index`th child of this object to `t`.
`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`	`setSemiColon(boolean needs_semi_colon)` Marks this declaration needs semi colon when printed.
`java.lang.String`	`toString()` Converts this declaration to a string by calling the default print method.
`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.

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

- Method Detail
  - clone
```
public Declaration clone()
```
    Creates and returns a deep copy of this declaration.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    a deep copy of this declaration.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Checks if the declaration is equal to the given object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    o - the object to be compared.
    
    Returns:
    true if o == this.
  - hashCode
```
public int hashCode()
```
    Returns the hash code of the declaration. It returns the identity hash code of the declaration.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    the identity hash code of the declaration.
  - detach
```
public void detach()
```
    Detaches this declaration 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.
  - getDeclaredIDs
```
public abstract java.util.List<IDExpression> getDeclaredIDs()
```
    Returns a list of name ID introduced by this declaration.
    
    Returns:
    a list of IDExpressions. The list will not be null but may be empty.
  - 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.
  - print
```
public void print(java.io.PrintWriter o)
```
    Prints this declaration to the specified print writer.
    
    Specified by:
    
    print in interface Printable
    
    Parameters:
    o - the target print writer.
  - toString
```
public java.lang.String toString()
```
    Converts this declaration to a string by calling the default print method. All sub classes will be using this method unless special handling is necessary.
    
    Overrides:
    
    toString in class java.lang.Object
  - removeChild
```
public void removeChild(Traversable child)
```
    This operation is not allowed.
    
    Specified by:
    
    removeChild in interface Traversable
    
    Parameters:
    child - a reference to a child object that must match with ==.
    
    Throws:
    
    java.lang.UnsupportedOperationException - always.
  - 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.
  - 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 declaration. The default position of the annotation is before the declaration.
    
    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 declaration.
    
    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 declaration.
    
    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 declaration. 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 declaration.
    
    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 declaration 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 declaration.
    
    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 declaration.
    
    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.
  - setSemiColon
```
public void setSemiColon(boolean needs_semi_colon)
```
    Marks this declaration needs semi colon when printed.

Class Declaration

Method Summary

Methods inherited from class java.lang.Object

Method Detail

clone

equals

hashCode

detach

getChildren

getDeclaredIDs

getParent

print

toString

removeChild

setChild

setParent

setPrintMethod

verify

annotate

annotateAfter

annotateBefore

getAnnotations

getAnnotations

containsAnnotation

getAnnotation

getAnnotations

removeAnnotations

removeAnnotations

setSemiColon