ForLoopTree.java revision 1209:36fbf759ab8d 
1/*
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package jdk.nashorn.api.tree;
27
28/**
29 * A tree node for a basic 'for' loop statement.
30 *
31 * For example:
32 * <pre>
33 *   for ( <em>initializer</em> ; <em>condition</em> ; <em>update</em> )
34 *       <em>statement</em>
35 * </pre>
36 *
37 * @since 1.9
38 */
39@jdk.Exported
40public interface ForLoopTree extends ConditionalLoopTree {
41    /**
42     * Returns the initializer expression of this 'for' statement.
43     *
44     * @return the initializer expression
45     */
46    ExpressionTree getInitializer();
47
48    /**
49     * Returns the condition expression of this 'for' statement.
50     *
51     * @return the condition expression
52     */
53    @Override
54    ExpressionTree getCondition();
55
56    /**
57     * Returns the update expression of this 'for' statement.
58     *
59     * @return the update expression
60     */
61    ExpressionTree getUpdate();
62
63    /**
64     * Returns the statement contained in this 'for' statement.
65     *
66     * @return the statement
67     */
68    @Override
69    StatementTree getStatement();
70}
71