Declarator

java.lang.Object
- cetus.hir.Declarator

All Implemented Interfaces:

Printable, Traversable, java.lang.Cloneable

Direct Known Subclasses:

NestedDeclarator, ProcedureDeclarator, VariableDeclarator
```
public abstract class Declarator
extends java.lang.Object
implements java.lang.Cloneable, Traversable
```
Represents the part of a declaration that is the name of the symbol, some type information, and initial values. This class actually is more similar to what the C++ grammar calls an init-declarator. Many different constructors are provided because Java does not have default arguments.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract void`	`addParameter(Declaration decl)` Inserts a new child declaration to the parameter list.
`abstract void`	`addParameterAfter(Declaration ref, Declaration decl)` Inserts a new child declaration to the parameter list after the given reference declaration.
`abstract void`	`addParameterBefore(Declaration ref, Declaration decl)` Inserts a new child declaration to the parameter list before the given reference declaration.
`void`	`addTrailingSpecifier(Specifier spec)` Appends a new specifier to the list of trailing specifiers.
`Declarator`	`clone()`
`static void`	`defaultPrint(Declarator d, java.io.PrintWriter o)` Prints a declarator to a stream.
`boolean`	`equals(java.lang.Object o)` Checks if the given object is equal to the declarator.
`java.util.List<Specifier>`	`getArraySpecifiers()` Returns the list of specifiers trailing the declarator.
`java.util.List<Traversable>`	`getChildren()` Provides access to the children of this object as a list.
`abstract IDExpression`	`getID()` Returns the symbol declared by this declarator.
`Initializer`	`getInitializer()` Returns the variable initializer of the declarator if one exists.
`Declaration`	`getParameter(int index)` Returns the parameter at specified index.
`abstract java.util.List<Declaration>`	`getParameters()` Returns a List of Function Parameter
`Traversable`	`getParent()` Provides access to the parent of this object.
`java.util.List<Specifier>`	`getSpecifiers()` Returns the list of specifiers leading the declarator.
`int`	`hashCode()` Returns the hash code of the declarator.
`void`	`print(java.io.PrintWriter o)` Prints the declarator to the specified print writer.
`void`	`removeChild(Traversable child)` This traversable interface is not supported for declarators.
`void`	`setChild(int index, Traversable t)` This traversable interface is not supported for declarators.
`void`	`setInitializer(Initializer init)` Sets the initial value of the variable.
`void`	`setParent(Traversable t)` Sets the parent of this object.
`java.lang.String`	`toString()` Converts the declarator to a string by calling the default print method.

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

- Method Detail
  - addParameter
```
public abstract void addParameter(Declaration decl)
```
    Inserts a new child declaration to the parameter list.
    
    Parameters:
    decl - the new parameter declaration to be inserted.
    
    Throws:
    
    NotAnOrphanException - if decl has a parent object.
  - addParameterBefore
```
public abstract void addParameterBefore(Declaration ref,
                      Declaration decl)
```
    Inserts a new child declaration to the parameter list before the given reference declaration.
    
    Parameters:
    ref - the reference parameter declaration.
    decl - the new parameter declaration to be inserted.
    
    Throws:
    
    java.lang.IllegalArgumentException - if ref is not found.
    
    NotAnOrphanException - if decl has a parent object.
  - addParameterAfter
```
public abstract void addParameterAfter(Declaration ref,
                     Declaration decl)
```
    Inserts a new child declaration to the parameter list after the given reference declaration.
    
    Parameters:
    ref - the reference parameter declaration.
    decl - the new parameter declaration to be inserted.
    
    Throws:
    
    java.lang.IllegalArgumentException - if ref is not found.
    
    NotAnOrphanException - if decl has a parent object.
  - addTrailingSpecifier
```
public void addTrailingSpecifier(Specifier spec)
```
    Appends a new specifier to the list of trailing specifiers.
    
    Parameters:
    spec - the new specifier to be appended.
  - clone
```
public Declarator clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Checks if the given object is equal to the declarator.
    
    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 declarator.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    the identity hash code of the declarator.
  - defaultPrint
```
public static void defaultPrint(Declarator d,
                java.io.PrintWriter o)
```
    Prints a declarator to a stream.
    
    Parameters:
    d - The declarator to print.
    o - The writer on which to print the declarator.
  - toString
```
public java.lang.String toString()
```
    Converts the declarator 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
  - 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.
  - getInitializer
```
public Initializer getInitializer()
```
    Returns the variable initializer of the declarator if one exists.
    
    Returns:
    the initializer or null.
  - getParameters
```
public abstract java.util.List<Declaration> getParameters()
```
    Returns a List of Function Parameter
    
    Returns:
    List null is returned when there is no Function Parameter in the Declarator
  - getParameter
```
public Declaration getParameter(int index)
```
    Returns the parameter at specified index.
    
    Parameters:
    index - - zero-based index of the required parameter
    
    Returns:
    - parameter at specified index or null
  - 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.
  - getArraySpecifiers
```
public java.util.List<Specifier> getArraySpecifiers()
```
    Returns the list of specifiers trailing the declarator.
    
    Returns:
    the trailing specifiers.
  - getSpecifiers
```
public java.util.List<Specifier> getSpecifiers()
```
    Returns the list of specifiers leading the declarator.
    
    Returns:
    the leading specifiers.
  - getID
```
public abstract IDExpression getID()
```
    Returns the symbol declared by this declarator.
    
    Returns:
    the name ID of the declarator.
  - print
```
public void print(java.io.PrintWriter o)
```
    Prints the declarator to the specified print writer.
    
    Specified by:
    
    print in interface Printable
    
    Parameters:
    o - The writer on which to print the data.
  - removeChild
```
public void removeChild(Traversable child)
```
    This traversable interface is not supported for declarators.
    
    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)
```
    This traversable interface is not supported for declarators.
    
    Specified by:
    
    setChild in interface Traversable
    
    Throws:
    
    java.lang.UnsupportedOperationException - always.
  - setInitializer
```
public void setInitializer(Initializer init)
```
    Sets the initial value of the variable. The initial value cannot be set in the constructor, for the purpose of limiting the number of constructors.
    
    Parameters:
    init - An initial value for the variable.
  - 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

Class Declarator

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addParameter

addParameterBefore

addParameterAfter

addTrailingSpecifier

clone

equals

hashCode

defaultPrint

toString

getChildren

getInitializer

getParameters

getParameter

getParent

getArraySpecifiers

getSpecifiers

getID

print

removeChild

setChild

setInitializer

setParent