Tue, 24 Dec 2013 09:17:37 -0800
8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com
duke@1 | 1 | /* |
ksrini@2227 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package javax.lang.model.element; |
duke@1 | 27 | |
duke@1 | 28 | import javax.lang.model.util.Elements; |
duke@1 | 29 | |
duke@1 | 30 | /** |
duke@1 | 31 | * Represents a field, {@code enum} constant, method or constructor |
darcy@849 | 32 | * parameter, local variable, resource variable, or exception |
darcy@849 | 33 | * parameter. |
duke@1 | 34 | * |
duke@1 | 35 | * @author Joseph D. Darcy |
duke@1 | 36 | * @author Scott Seligman |
duke@1 | 37 | * @author Peter von der Ahé |
duke@1 | 38 | * @since 1.6 |
duke@1 | 39 | */ |
duke@1 | 40 | public interface VariableElement extends Element { |
duke@1 | 41 | |
duke@1 | 42 | /** |
duke@1 | 43 | * Returns the value of this variable if this is a {@code final} |
duke@1 | 44 | * field initialized to a compile-time constant. Returns {@code |
duke@1 | 45 | * null} otherwise. The value will be of a primitive type or a |
duke@1 | 46 | * {@code String}. If the value is of a primitive type, it is |
duke@1 | 47 | * wrapped in the appropriate wrapper class (such as {@link |
duke@1 | 48 | * Integer}). |
duke@1 | 49 | * |
duke@1 | 50 | * <p>Note that not all {@code final} fields will have |
duke@1 | 51 | * constant values. In particular, {@code enum} constants are |
duke@1 | 52 | * <em>not</em> considered to be compile-time constants. To have a |
duke@1 | 53 | * constant value, a field's type must be either a primitive type |
duke@1 | 54 | * or {@code String}. |
duke@1 | 55 | * |
duke@1 | 56 | * @return the value of this variable if this is a {@code final} |
duke@1 | 57 | * field initialized to a compile-time constant, or {@code null} |
duke@1 | 58 | * otherwise |
duke@1 | 59 | * |
duke@1 | 60 | * @see Elements#getConstantExpression(Object) |
jjh@972 | 61 | * @jls 15.28 Constant Expression |
jjh@972 | 62 | * @jls 4.12.4 final Variables |
duke@1 | 63 | */ |
duke@1 | 64 | Object getConstantValue(); |
darcy@1484 | 65 | |
darcy@1484 | 66 | /** |
darcy@1484 | 67 | * Returns the simple name of this variable element. |
darcy@1484 | 68 | * |
darcy@1484 | 69 | * <p>For method and constructor parameters, the name of each |
darcy@1484 | 70 | * parameter must be distinct from the names of all other |
darcy@1484 | 71 | * parameters of the same executable. If the original source |
darcy@1484 | 72 | * names are not available, an implementation may synthesize names |
darcy@1484 | 73 | * subject to the distinctness requirement above. |
darcy@1484 | 74 | * |
darcy@1484 | 75 | * @return the simple name of this variable element |
darcy@1484 | 76 | */ |
darcy@1484 | 77 | @Override |
darcy@1484 | 78 | Name getSimpleName(); |
darcy@1484 | 79 | |
darcy@1484 | 80 | /** |
darcy@1484 | 81 | * Returns the enclosing element of this variable. |
darcy@1484 | 82 | * |
darcy@1484 | 83 | * The enclosing element of a method or constructor parameter is |
darcy@1484 | 84 | * the executable declaring the parameter. |
darcy@1484 | 85 | * |
darcy@1484 | 86 | * @return the enclosing element of this variable |
darcy@1484 | 87 | */ |
darcy@1484 | 88 | @Override |
darcy@1484 | 89 | Element getEnclosingElement(); |
duke@1 | 90 | } |