org.apache.royale.compiler.tree.as.ITryNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of compiler Show documentation

The Apache Royale Compiler

There is a newer version: 0.9.10

/*
 *
 *  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 try statement.
 * 
 * The shape of this node is:
 * 
 * ITryNode 
 *   IBlockNode    <-- getStatementContentsNode()
 *   ICatchNode    <-- getCatchNode(0)
 *   ICatchNode    <-- getCatchNode(1)
 *   ...
 *   ITerminalNode <-- getFinallyNode()
 * 
 * For example,
 *  * try
 * {
 *     ...
 * }
 * catch (e:SomeError)
 * {
 *     ...
 * }
 * catch (e:Error)
 * {
 *     ...
 * }
 * finally
 * {
 *     ...
 * }
 * 
 * is represented as
 *  * ITryNode
 *   IBlockNode
 *     ...
 *   ICatchNode
 *     IParameterNode
 *       IIdentifierNode "e"
 *       IIdentifierNode "Error"
 *     IBlockNode
 *       ...
 *   ICatchNode
 *     IParameterNode
 *       IIdentifierNode "e"
 *       IIdentifierNode "Error"
 *     IBlockNode
 *       ...
 *   ITerminalNode "finally"
 *     IBlockNode
 *       ...
 * 
 */
public interface ITryNode extends IStatementNode
{
    /**
     * Returns the number of catch clauses for this
     * try statement.
     */
    int getCatchNodeCount();

    /**
     * Returns the ith catch clause for this
     * try statement.
     * 
     * @return an {@link ICatchNode} or null
     */
    ICatchNode getCatchNode(int i);

    /**
     * Returns the finally clause of this try
     * statement.
     * 
     * @return an {@link ITerminalNode} or null
     */
    ITerminalNode getFinallyNode();
}