compiler/src/main/java/org/apache/royale/compiler/tree/as/IReturnNode.java

/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (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.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package org.apache.royale.compiler.tree.as;

/**
 * An AST node representing a <code>return</code> statement.
 * <p>
 * The shape of this node is:
 * <pre>
 * IReturnNode 
 *   IExpressionNode <-- getReturnValueNode()
 * </pre>
 * For example, <pre>return a + b;</pre> is represented as
 * <pre>
 * IReturnNode
 *   IBinaryOperatorNode "+"
 *     IIdentifierNode "a"
 *     IIdentiferNode "b"
 * </pre>
 * If there is no return value, then there is no child node.
 */
public interface IReturnNode extends IExpressionNode
{
    /**
     * Represents the condition that is being returned by the return statement
     * 
     * @return an {@link IExpressionNode} or null
     */
    IExpressionNode getReturnValueNode();
}