tip.node
Class AReturnStm

java.lang.Object
  extended by tip.node.Node
      extended by tip.node.PStm
          extended by tip.node.AReturnStm
All Implemented Interfaces:
Cloneable, NodeInterface

public final class AReturnStm
extends PStm

AReturnStm represents the return alternative of the stm production in the AST.


Constructor Summary
AReturnStm()
          Creates a new AReturnStm node with no children.
AReturnStm(TReturn _token_, PExp _exp_)
          Creates a new AReturnStm node with the given nodes as children.
 
Method Summary
 void apply(Analysis caller)
          Calls the Analysis.caseAReturnStm(AReturnStm) of the Analysis caller.
<A> A
apply(Answer<A> caller)
          Returns the answer for caller by applying this AReturnStm node to the Answer visitor.
<Q> void
apply(Question<Q> caller, Q question)
          Applies this AReturnStm node to the Question visitor caller.
<Q,A> A
apply(QuestionAnswer<Q,A> caller, Q question)
          Returns the answer for caller by applying this AReturnStm node with the question to the QuestionAnswer visitor.
 void checkOptionalInvariant()
           
 AReturnStm clone()
          Returns a deep clone of this AReturnStm node.
 AReturnStm clone(Map<Node,Node> oldToNewMap)
          Creates a deep clone of this AReturnStm node while putting all old node-new node relations in the map oldToNewMap.
<T extends NodeInterface>
void
getChildren(Collection<T> collection, NodeFilter<T> filter)
          Adds all children of this AReturnStm node that are accepted by the NodeFilter filter to collection.
<T extends NodeInterface>
void
getDescendants(Collection<T> collection, NodeFilter<T> filter)
          Adds all descendants of this AReturnStm node (including the node itself) that are accepted by the NodeFilter filter to collection.
 PExp getExp()
          Returns the PExp node which is the exp child of this AReturnStm node.
 TReturn getToken()
          Returns the TReturn node which is the token child of this AReturnStm node.
 EStm kindPStm()
          Returns the EStm corresponding to the type of this PStm node.
 void setExp(PExp value)
          Sets the exp child of this AReturnStm node.
 void setToken(TReturn value)
          Sets the token child of this AReturnStm node.
 String toString()
          Returns a textual representation of this AReturnStm node.
 
Methods inherited from class tip.node.PStm
kindNode
 
Methods inherited from class tip.node.Node
getAncestor, getAncestor, getAncestor, getChildren, getChildren, getDescendants, getDescendants, getDescendants, isOptionalInvariant, parent, replaceBy, setOptionalInvariant
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AReturnStm

public AReturnStm()
Creates a new AReturnStm node with no children.


AReturnStm

public AReturnStm(TReturn _token_,
                  PExp _exp_)
Creates a new AReturnStm node with the given nodes as children. The basic child nodes are removed from their previous parents.

Parameters:
_token_ - the TReturn node for the Token child of this AReturnStm node
_exp_ - the PExp node for the Exp child of this AReturnStm node
Method Detail

clone

public AReturnStm clone()
Returns a deep clone of this AReturnStm node.

Specified by:
clone in interface NodeInterface
Specified by:
clone in class PStm
Returns:
a deep clone of this AReturnStm node

clone

public AReturnStm clone(Map<Node,Node> oldToNewMap)
Creates a deep clone of this AReturnStm node while putting all old node-new node relations in the map oldToNewMap.

Specified by:
clone in interface NodeInterface
Specified by:
clone in class PStm
Parameters:
oldToNewMap - the map filled with the old node-new node relation
Returns:
a deep clone of this AReturnStm node

toString

public String toString()
Returns a textual representation of this AReturnStm node.

Overrides:
toString in class Object
Returns:
a textual representation of this AReturnStm node

kindPStm

public EStm kindPStm()
Returns the EStm corresponding to the type of this PStm node.

Specified by:
kindPStm in class PStm
Returns:
the EStm for this node

getToken

public TReturn getToken()
Returns the TReturn node which is the token child of this AReturnStm node.

Specified by:
getToken in class PStm
Returns:
the TReturn node which is the token child of this AReturnStm node

setToken

public void setToken(TReturn value)
Sets the token child of this AReturnStm node.

Parameters:
value - the new token child of this AReturnStm node

getExp

public PExp getExp()
Returns the PExp node which is the exp child of this AReturnStm node.

Returns:
the PExp node which is the exp child of this AReturnStm node

setExp

public void setExp(PExp value)
Sets the exp child of this AReturnStm node.

Parameters:
value - the new exp child of this AReturnStm node

getDescendants

public <T extends NodeInterface> void getDescendants(Collection<T> collection,
                                                     NodeFilter<T> filter)
Adds all descendants of this AReturnStm node (including the node itself) that are accepted by the NodeFilter filter to collection.

Specified by:
getDescendants in interface NodeInterface
Specified by:
getDescendants in class Node
Parameters:
collection - the collection to which the descendants are added
filter - the NodeFilter used

getChildren

public <T extends NodeInterface> void getChildren(Collection<T> collection,
                                                  NodeFilter<T> filter)
Adds all children of this AReturnStm node that are accepted by the NodeFilter filter to collection.

Specified by:
getChildren in interface NodeInterface
Specified by:
getChildren in class Node
Parameters:
collection - the collection to which the children are added
filter - the NodeFilter used

checkOptionalInvariant

public void checkOptionalInvariant()
Specified by:
checkOptionalInvariant in interface NodeInterface
Specified by:
checkOptionalInvariant in class Node

apply

public void apply(Analysis caller)
Calls the Analysis.caseAReturnStm(AReturnStm) of the Analysis caller.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
sw - the Analysis to which this AReturnStm node is applied

apply

public <A> A apply(Answer<A> caller)
Returns the answer for caller by applying this AReturnStm node to the Answer visitor.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
caller - the Answer to which this node is applied
Returns:
the answer as returned from caller

apply

public <Q> void apply(Question<Q> caller,
                      Q question)
Applies this AReturnStm node to the Question visitor caller.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
caller - the Question to which this node is applied
question - the question provided to caller

apply

public <Q,A> A apply(QuestionAnswer<Q,A> caller,
                     Q question)
Returns the answer for caller by applying this AReturnStm node with the question to the QuestionAnswer visitor.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
caller - the QuestionAnswer to which this node is applied
question - the question provided to caller
Returns:
the answer as returned from caller