1 /*
2  * Copyright (c) 2005, 2014, 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 
26 package com.sun.source.tree;
27 
28 import java.util.List;
29 
30 /**
31  * A tree node for a basic {@code for} loop statement.
32  *
33  * For example:
34  * <pre>
35  *   for ( <em>initializer</em> ; <em>condition</em> ; <em>update</em> )
36  *       <em>statement</em>
37  * </pre>
38  *
39  * @jls 14.14.1 The basic for Statement
40  *
41  * @author Peter von der Ah&eacute;
42  * @author Jonathan Gibbons
43  * @since 1.6
44  */
45 public interface ForLoopTree extends StatementTree {
46     /**
47      * Returns any initializers of the {@code for} statement.
48      * The result will be an empty list if there are
49      * no initializers
50      * @return the initializers
51      */
getInitializer()52     List<? extends StatementTree> getInitializer();
53 
54     /**
55      * Returns the condition of the {@code for} statement.
56      * May be {@code null} if there is no condition.
57      * @return the condition
58      */
getCondition()59     ExpressionTree getCondition();
60 
61     /**
62      * Returns any update expressions of the {@code for} statement.
63      * @return the update expressions
64      */
getUpdate()65     List<? extends ExpressionStatementTree> getUpdate();
66 
67     /**
68      * Returns the body of the {@code for} statement.
69      * @return the body
70      */
getStatement()71     StatementTree getStatement();
72 }
73