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 
  26 package jdk.nashorn.api.tree;
  27 
  28 /**
  29  * A tree node for for..in statement
  30  *
  31  * For example:
  32  * <pre>
  33  *   for ( <em>variable</em> in <em>expression</em> )
  34  *       <em>statement</em>
  35  * </pre>
  36  *
  37  * @since 1.9
  38  */
  39 @jdk.Exported
  40 public interface ForInLoopTree extends LoopTree {
  41     /**
  42      * The for..in left hand side expression.
  43      *
  44      * @return the left hand side expression
  45      */
  46     ExpressionTree getVariable();
  47     
  48     /**
  49      * The object or array being whose properties are iterated.
  50      * 
  51      * @return the object or array expression being iterated
  52      */
  53     ExpressionTree getExpression();
  54     
  55     /**
  56      * The statement contained in this for..in statement.
  57      * 
  58      * @return the statement
  59      */
  60     StatementTree getStatement();
  61     
  62     /**
  63      * Returns if this is a for..each..in statement or not.
  64      * 
  65      * @return true if this is a for..each..in statement 
  66      */
  67     boolean isForEach();
  68 }