/*

 * Copyright (c) 2005, 2014, 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 com.sun.source.tree;

import javax.lang.model.element.Name;

/**

 * A tree node for a variable declaration.

 *

 * For example:

 * <pre>

 *   <em>modifiers</em> <em>type</em> <em>name</em> <em>initializer</em> ;

 *   <em>modifiers</em> <em>type</em> <em>qualified-name</em>.this

 * </pre>

 *

 * @jls sections 8.3 and 14.4

 *

 * @author Peter von der Ahé

 * @author Jonathan Gibbons

 * @since 1.6

 */

public interface VariableTree extends StatementTree {

    /**

     * Returns the modifiers, including any annotations, on the declaration.

     * @return the modifiers

     */

    ModifiersTree getModifiers();

    /**

     * Returns the name of the variable being declared.

     * @return the name

     */

    Name getName();

    /**

     * Returns the qualified identifier for the name being "declared".

     * This is only used in certain cases for the receiver of a

     * method declaration. Returns {@code null} in all other cases.

     * @return the qualified identifier of a receiver declaration

     */

    ExpressionTree getNameExpression();

    /**

     * Returns the type of the variable being declared.

     * @return the type

     */

    Tree getType();

    /**

     * Returns the initializer for the variable, or {@code null} if none.

     * @return the initializer

     */

    ExpressionTree getInitializer();

}