/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Rhino code, released
* May 6, 1999.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1997-1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Steve Yegge
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU General Public License Version 2 or later (the "GPL"), in which
* case the provisions of the GPL are applicable instead of those above. If
* you wish to allow use of your version of this file only under the terms of
* the GPL and not to allow others to use your version of this file under the
* MPL, indicate your decision by deleting the provisions above and replacing
* them with the notice and other provisions required by the GPL. If you do
* not delete the provisions above, a recipient may use your version of this
* file under either the MPL or the GPL.
*
* ***** END LICENSE BLOCK ***** */
package org.mozilla.javascript.ast;
import org.mozilla.javascript.Token;
/**
* Return statement. Node type is {@link Token#RETURN}.<p>
*
* <pre><i>ReturnStatement</i> :
* <b>return</b> [<i>no LineTerminator here</i>] [Expression] ;</pre>
*/
public class ReturnStatement extends AstNode {
private AstNode returnValue;
{
type = Token.RETURN;
}
public ReturnStatement() {
}
public ReturnStatement(int pos) {
super(pos);
}
public ReturnStatement(int pos, int len) {
super(pos, len);
}
public ReturnStatement(int pos, int len, AstNode returnValue) {
super(pos, len);
setReturnValue(returnValue);
}
/**
* Returns return value, {@code null} if return value is void
*/
public AstNode getReturnValue() {
return returnValue;
}
/**
* Sets return value expression, and sets its parent to this node.
* Can be {@code null}.
*/
public void setReturnValue(AstNode returnValue) {
this.returnValue = returnValue;
if (returnValue != null)
returnValue.setParent(this);
}
@Override
public String toSource(int depth) {
StringBuilder sb = new StringBuilder();
sb.append(makeIndent(depth));
sb.append("return");
if (returnValue != null) {
sb.append(" ");
sb.append(returnValue.toSource(0));
}
sb.append(";\n");
return sb.toString();
}
/**
* Visits this node, then the return value if specified.
*/
@Override
public void visit(NodeVisitor v) {
if (v.visit(this) && returnValue != null) {
returnValue.visit(v);
}
}
}