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 section 14.14.1

    40  *

    41  * @author Peter von der Ahé

    42  * @author Jonathan Gibbons

    43  * @since 1.6

    44  */

    45 @jdk.Exported

    46 public interface ForLoopTree extends StatementTree {

    47     /**

    48      * Returns any initializers of the {@code for} statement.

    49      * The result will be an empty list if there are

    50      * no initializers

    51      * @return the initializers

    52      */

    53     List<? extends StatementTree> getInitializer();

    54 

    55     /**

    56      * Returns the condition of the {@code for} statement.

    57      * May be {@code null} if there is no condition.

    58      * @return the condition

    59      */

    60     ExpressionTree getCondition();

    61 

    62     /**

    63      * Returns any update expressions of the {@code for} statement.

    64      * @return the update expressions

    65      */

    66     List<? extends ExpressionStatementTree> getUpdate();

    67 

    68     /**

    69      * Returns the body of the {@code for} statement.

    70      * @return the body

    71      */

    72     StatementTree getStatement();

    73 }