1 /*
   2  * Copyright (c) 2016, 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 a <a href="http://www.ecma-international.org/ecma-262/6.0/#sec-variable-statement">variable declaration statement</a>.
  30  *
  31  * For example:
  32  * <pre>
  33  *   <em>var</em> <em>name</em> [ <em>initializer</em> ] ;
  34  *   <em>var</em> <em>binding_pattern</em> [ <em>initializer</em> ];
  35  * </pre>
  36  *
  37  * @since 9
  38  */
  39 public interface VariableTree extends StatementTree {
  40     /**
  41      * Returns the binding of this declaration. This is an {@link IdentifierTree}
  42      * for a binding identifier case (simple variable declaration).
  43      * This is an {@link ObjectLiteralTree} or a {@link ArrayLiteralTree} for a
  44      * destructuring declaration.
  45      *
  46      * @return the binding expression of this declaration
  47      */
  48     ExpressionTree getBinding();
  49 
  50     /**
  51      * Returns the initial value expression for this variable. This is
  52      * null if no initial value for this variable.
  53      *
  54      * @return the initial value expression
  55      */
  56     ExpressionTree getInitializer();
  57 
  58     /**
  59      * Is this a const declaration?
  60      *
  61      * @return true if this is a const declaration
  62      */
  63     boolean isConst();
  64 
  65     /**
  66      * Is this a let declaration?
  67      *
  68      * @return true if this is a let declaration
  69      */
  70     boolean isLet();
  71 }