Package org.eclipse.jdt.core.dom

Class SingleVariableDeclaration

java.lang.Object
org.eclipse.jdt.core.dom.ASTNode
org.eclipse.jdt.core.dom.VariableDeclaration
org.eclipse.jdt.core.dom.SingleVariableDeclaration
public class SingleVariableDeclaration extends VariableDeclaration
Single variable declaration AST node type. Single variable declaration nodes are used in a limited number of places, including formal parameter lists and catch clauses. They are not used for field declarations and regular variable declaration statements. 
 SingleVariableDeclaration:
    { ExtendedModifier } Type {Annotation} [ ... ] Identifier { Dimension } [ = Expression ]

Note: There's currently no construct in the Java language that allows an initializer on a SingleVariableDeclaration.

Since:
2.0
Restriction:
This class is not intended to be instantiated by clients.

  • Field Details

    • MODIFIERS_PROPERTY

      public static final SimplePropertyDescriptor MODIFIERS_PROPERTY
      Deprecated.
      In the JLS3 API, this property is replaced by MODIFIERS2_PROPERTY.
      The "modifiers" structural property of this node type (type: Integer) (JLS2 API only).
      Since:
      3.0

    • MODIFIERS2_PROPERTY

      public static final ChildListPropertyDescriptor MODIFIERS2_PROPERTY
      The "modifiers" structural property of this node type (element type: IExtendedModifier) (added in JLS3 API).
      Since:
      3.1

    • TYPE_PROPERTY

      public static final ChildPropertyDescriptor TYPE_PROPERTY
      The "type" structural property of this node type (child type: Type).
      Since:
      3.0

    • VARARGS_ANNOTATIONS_PROPERTY

      public static final ChildListPropertyDescriptor VARARGS_ANNOTATIONS_PROPERTY
      The "varargsAnnotations" structural property of variable arguments of this node type (element type: Annotation) (added in JLS8 API).
      Since:
      3.10

    • VARARGS_PROPERTY

      public static final SimplePropertyDescriptor VARARGS_PROPERTY
      The "varargs" structural property of this node type (type: Boolean) (added in JLS3 API).
      Since:
      3.1

    • NAME_PROPERTY

      public static final ChildPropertyDescriptor NAME_PROPERTY
      The "name" structural property of this node type (child type: SimpleName).
      Since:
      3.0

    • EXTRA_DIMENSIONS_PROPERTY

      public static final SimplePropertyDescriptor EXTRA_DIMENSIONS_PROPERTY
      Deprecated.
      In JLS8 and later, use EXTRA_DIMENSIONS2_PROPERTY instead.
      The "extraDimensions" structural property of this node type (type: Integer) (before JLS8 only).
      Since:
      3.0

    • EXTRA_DIMENSIONS2_PROPERTY

      public static final ChildListPropertyDescriptor EXTRA_DIMENSIONS2_PROPERTY
      The "extraDimensions2" structural property of this node type (element type: Dimension) (added in JLS8 API).
      Since:
      3.10

    • INITIALIZER_PROPERTY

      public static final ChildPropertyDescriptor INITIALIZER_PROPERTY
      The "initializer" structural property of this node type (child type: Expression).
      Since:
      3.0

  • Method Details

    • propertyDescriptors

      public static List propertyDescriptors(int apiLevel)
      Returns a list of structural property descriptors for this node type. Clients must not modify the result.
      Parameters:
      apiLevel - the API level; one of the AST.JLS* constants
      Returns:
      a list of property descriptors (element type: StructuralPropertyDescriptor)
      Since:
      3.0

    • modifiers

      public List modifiers()
      Returns the live ordered list of modifiers and annotations of this declaration (added in JLS3 API).

      Note that the final modifier is the only meaningful modifier for local variable and formal parameter declarations.

      Returns:
      the live list of modifiers and annotations (element type: IExtendedModifier)
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2 AST
      Since:
      3.1

    • getModifiers

      public int getModifiers()
      Returns the modifiers explicitly specified on this declaration.

      In the JLS3 API, this method is a convenience method that computes these flags from modifiers().

      Returns:
      the bit-wise or of Modifier constants
      See Also:

    • setModifiers

      public void setModifiers(int modifiers)
      Deprecated.
      In the JLS3 API, this method is replaced by modifiers() which contains a list of a Modifier nodes.
      Sets the modifiers explicitly specified on this declaration (JLS2 API only).

      The following modifiers are meaningful for fields: public, private, protected, static, final, volatile, and transient. For local variable and formal parameter declarations, the only meaningful modifier is final.

      Parameters:
      modifiers - the given modifiers (bit-wise or of Modifier constants)
      Throws:
      UnsupportedOperationException - if this operation is used in an AST later than JLS2
      See Also:

    • getType

      public Type getType()
      Returns the type of the variable declared in this variable declaration, exclusive of any extra array dimensions or the varargs dimension.

      WARNING: For array-typed varargs, the binding of the returned Type is not useful, since it represents an unused type. It misses the last (innermost) dimension that carries the varargsAnnotations().

      Returns:
      the type

    • setType

      public void setType(Type type)
      Sets the type of the variable declared in this variable declaration to the given type, exclusive of any extra array dimensions.
      Parameters:
      type - the new type
      Throws:
      IllegalArgumentException - if:
      • the node belongs to a different AST
      • the node already has a parent

    • isVarargs

      public boolean isVarargs()
      Returns whether this declaration declares the last parameter of a variable arity method (added in JLS3 API).

      Note that the binding for the type Foo in the vararg method declaration void fun(Foo... args) is always for the type as written; i.e., the type binding for Foo. However, if you navigate from the method declaration to its method binding to the type binding for its last parameter, the type binding for the vararg parameter is always an array type (i.e., Foo[]) reflecting the way vararg methods get compiled.

      WARNING: For array-typed varargs, the binding of the variable's type is not useful, since it represents an unused type. It misses the last (innermost) dimension that carries the varargsAnnotations().

      Returns:
      true if this is a variable arity parameter declaration, and false otherwise
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2 AST
      Since:
      3.1

    • setVarargs

      public void setVarargs(boolean variableArity)
      Sets whether this declaration declares the last parameter of a variable arity method (added in JLS3 API).
      Parameters:
      variableArity - true if this is a variable arity parameter declaration, and false otherwise
      Since:
      3.1

    • varargsAnnotations

      public List varargsAnnotations()
      Returns the ordered list of annotations on the varargs token (added in JLS8 API).

      WARNING: For array-typed varargs, the binding of the variable's type is not useful, since it represents an unused type. It misses the last (innermost) dimension that carries the returned varargsAnnotations.

      Returns:
      the list of annotations on the varargs token (element type: Annotation)
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2, JLS3 or JLS4 AST
      Since:
      3.10
      See Also: