VariableTree.java revision 3193:3b3bea483542 
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
26package com.sun.source.tree;
27
28import javax.lang.model.element.Name;
29
30/**
31 * A tree node for a variable declaration.
32 *
33 * For example:
34 * <pre>
35 *   <em>modifiers</em> <em>type</em> <em>name</em> <em>initializer</em> ;
36 *   <em>modifiers</em> <em>type</em> <em>qualified-name</em>.this
37 * </pre>
38 *
39 * @jls sections 8.3 and 14.4
40 *
41 * @author Peter von der Ah&eacute;
42 * @author Jonathan Gibbons
43 * @since 1.6
44 */
45public interface VariableTree extends StatementTree {
46    /**
47     * Returns the modifiers, including any annotations, on the declaration.
48     * @return the modifiers
49     */
50    ModifiersTree getModifiers();
51
52    /**
53     * Returns the name of the variable being declared.
54     * @return the name
55     */
56    Name getName();
57
58    /**
59     * Returns the qualified identifier for the name being "declared".
60     * This is only used in certain cases for the receiver of a
61     * method declaration. Returns {@code null} in all other cases.
62     * @return the qualified identifier of a receiver declaration
63     */
64    ExpressionTree getNameExpression();
65
66    /**
67     * Returns the type of the variable being declared.
68     * @return the type
69     */
70    Tree getType();
71
72    /**
73     * Returns the initializer for the variable, or {@code null} if none.
74     * @return the initializer
75     */
76    ExpressionTree getInitializer();
77}
78