VariableTree.java

/*
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.nashorn.api.tree;

/**
 * A tree node for a <a href="http://www.ecma-international.org/ecma-262/6.0/#sec-variable-statement">variable declaration statement</a>.
 *
 * For example:
 * <pre>
 *   <em>var</em> <em>name</em> [ <em>initializer</em> ] ;
 *   <em>var</em> <em>binding_pattern</em> [ <em>initializer</em> ];
 * </pre>
 *
 * @since 9
 */
public interface VariableTree extends StatementTree {
    /**
     * Returns the binding of this declaration. This is an {@link IdentifierTree}
     * for a binding identifier case (simple variable declaration).
     * This is an {@link ObjectLiteralTree} or a {@link ArrayLiteralTree} for a
     * destructuring declaration.
     *
     * @return the binding expression of this declaration
     */
    ExpressionTree getBinding();

    /**
     * Returns the initial value expression for this variable. This is
     * null if no initial value for this variable.
     *
     * @return the initial value expression
     */
    ExpressionTree getInitializer();

    /**
     * Is this a const declaration?
     *
     * @return true if this is a const declaration
     */
    boolean isConst();

    /**
     * Is this a let declaration?
     *
     * @return true if this is a let declaration
     */
    boolean isLet();
}