org.teatrove.tea.parsetree
Class ReturnStatement

java.lang.Object
  org.teatrove.tea.parsetree.Node
      org.teatrove.tea.parsetree.Statement
          org.teatrove.tea.parsetree.ReturnStatement

All Implemented Interfaces:

Serializable, Cloneable

public class ReturnStatement
extends Statement

A ReturnStatement allows the values of Expressions to be returned from an execution scope. If the expression is null, then void is returned.

Author:

Brian S O'Neill

See Also:

Serialized Form

Constructor Summary

ReturnStatement(Expression expr)
Construct a ReturnStatement from just an expression and its SourceInfo.

ReturnStatement(SourceInfo info)
Construct a ReturnStatement that returns void.

ReturnStatement(SourceInfo info, Expression expr)

Method Summary

Object	accept(NodeVisitor visitor) Every subclass of Node must override this method with the following: return visitor.visit(this).
Object	clone() Returns a clone of this Node and all its children.
Expression	getExpression() Returns the expression to return or null if void is returned.
boolean	isBreak() Returns true if Statement 'breaks' during its execution.
boolean	isReturn() Returns true if Statement definitely returns from its method either from a return statement or a throw statement.
void	setExpression(Expression expr)

Methods inherited from class org.teatrove.tea.parsetree.Node

getSourceInfo, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReturnStatement

public ReturnStatement(SourceInfo info,
                       Expression expr)

ReturnStatement

public ReturnStatement(Expression expr)

Construct a ReturnStatement from just an expression and its SourceInfo.

ReturnStatement

public ReturnStatement(SourceInfo info)

Construct a ReturnStatement that returns void.

Method Detail

accept

public Object accept(NodeVisitor visitor)

Description copied from class: Node

Every subclass of Node must override this method with the following: return visitor.visit(this).

Overrides:

accept in class Statement

Parameters:

visitor - A visitor of this Node

Returns:

Node The Node returned by the visitor

See Also:

NodeVisitor

clone

public Object clone()

Description copied from class: Node

Returns a clone of this Node and all its children. Immutable child objects are not necessarily cloned

Overrides:

clone in class Node

isReturn

public boolean isReturn()

Description copied from class: Statement

Returns true if Statement definitely returns from its method either from a return statement or a throw statement.

Overrides:

isReturn in class Statement

isBreak

public boolean isBreak()

Description copied from class: Statement

Returns true if Statement 'breaks' during its execution.

Overrides:

isBreak in class Statement

getExpression

public Expression getExpression()

Returns the expression to return or null if void is returned.

setExpression

public void setExpression(Expression expr)