Interface VariableElement
-
- All Superinterfaces:
- AnnotatedConstruct, Element
public interface VariableElement extends Element
Represents a field,enumconstant, method or constructor parameter, local variable, resource variable, or exception parameter.- Since:
- 1.6
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ObjectgetConstantValue()Returns the value of this variable if this is afinalfield initialized to a compile-time constant.ElementgetEnclosingElement()Returns the enclosing element of this variable.NamegetSimpleName()Returns the simple name of this variable element.-
Methods inherited from interface javax.lang.model.element.Element
accept, asType, equals, getAnnotation, getAnnotationMirrors, getEnclosedElements, getKind, getModifiers, hashCode
-
Methods inherited from interface javax.lang.model.AnnotatedConstruct
getAnnotationsByType
-
-
-
-
Method Detail
getConstantValue
Object getConstantValue()
Returns the value of this variable if this is afinalfield initialized to a compile-time constant. Returnsnullotherwise. The value will be of a primitive type or aString. If the value is of a primitive type, it is wrapped in the appropriate wrapper class (such asInteger).Note that not all
finalfields will have constant values. In particular,enumconstants are not considered to be compile-time constants. To have a constant value, a field's type must be either a primitive type orString.- Returns:
-
the value of this variable if this is a
finalfield initialized to a compile-time constant, ornullotherwise - See Also:
-
Elements.getConstantExpression(Object) - See The Java™ Language Specification:
- 15.28 Constant Expression, 4.12.4 final Variables
getSimpleName
Name getSimpleName()
Returns the simple name of this variable element.For method and constructor parameters, the name of each parameter must be distinct from the names of all other parameters of the same executable. If the original source names are not available, an implementation may synthesize names subject to the distinctness requirement above.
- Specified by:
-
getSimpleNamein interfaceElement - Returns:
- the simple name of this variable element
- See Also:
-
PackageElement.getSimpleName(),ExecutableElement.getSimpleName(),TypeElement.getSimpleName(),getSimpleName()
getEnclosingElement
Element getEnclosingElement()
Returns the enclosing element of this variable. The enclosing element of a method or constructor parameter is the executable declaring the parameter.- Specified by:
-
getEnclosingElementin interfaceElement - Returns:
- the enclosing element of this variable
- See Also:
-
Elements.getPackageOf(javax.lang.model.element.Element)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
