src/main/java/io/devnulllabs/openjava/ptree/ReturnStatement.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

/*
 * ReturnStatement.java 1.0
 *
 *
 * Jun 20, 1997 by mich
 * Sep 29, 1997 by bv
 * Oct 11, 1997 by mich
 *
 * @see io.devnulllabs.openjava.ptree.ParseTree
 * @version 1.0 last updated:  Oct 11, 1997
 * @author  Michiaki Tatsubori
 */
package io.devnulllabs.openjava.ptree;

import io.devnulllabs.openjava.ptree.util.ParseTreeVisitor;

/**
 * The <code>ReturnStatement</code> class represents
 * a return statement node of parse tree.
 *
 * @see io.devnulllabs.openjava.ptree.ParseTree
 * @see io.devnulllabs.openjava.ptree.NonLeaf
 * @see io.devnulllabs.openjava.ptree.Statement
 */
public class ReturnStatement extends NonLeaf implements Statement, ParseTree {
    /**
     * Allocates a new object.
     *
     * @param  expr  the expression to be returned by this statement.
     *               If this is null, nothing to be returned.
     */
    public ReturnStatement(Expression expr) {
        super();
        set((ParseTree) expr);
    }

    /**
     * Allocates a new object.
     *
     */
    public ReturnStatement() {
        this(null);
    }

    /**
     * Gets the returned expression by this statement.
     *
     * @return  the expression to be returned by this statement.
     */
    public Expression getExpression() {
        return (Expression) elementAt(0);
    }

    /**
     * Sets the returned expression by this statement.
     *
     * @param  expr  the expression to be returned by this statement.
     */
    public void setExpression(Expression expr) {
        setElementAt(expr, 0);
    }

    public void accept(ParseTreeVisitor v) throws ParseTreeException {
        v.visit(this);
    }

}