Class VariableDeclaration

    • Method Detail

      • getNameProperty

        public final ChildPropertyDescriptor getNameProperty()
        Returns the structural property descriptor for the "name" property of this node (child type: SimpleName).
        Returns:
        the property descriptor
        Since:
        3.1
      • getExtraDimensionsProperty

        public final SimplePropertyDescriptor getExtraDimensionsProperty()
        Deprecated.
        In JLS8 and later, use getExtraDimensions2Property() instead.
        Returns the structural property descriptor for the "extraDimensions" property of this node (type: Integer) (below JLS8 only).
        Returns:
        the property descriptor
        Since:
        3.1
      • getExtraDimensions2Property

        public final ChildListPropertyDescriptor getExtraDimensions2Property()
        Returns the structural property descriptor for the "extraDimensions" property of this node (element type: Dimension) (added in JLS8 API).
        Returns:
        the property descriptor
        Since:
        3.10
      • getInitializerProperty

        public final ChildPropertyDescriptor getInitializerProperty()
        Returns structural property descriptor for the "initializer" property of this node (child type: Expression).
        Returns:
        the property descriptor
        Since:
        3.1
      • getName

        public SimpleName getName()
        Returns the name of the variable declared in this variable declaration.
        Returns:
        the variable name node
      • setName

        public void setName​(SimpleName variableName)
        Sets the name of the variable declared in this variable declaration to the given name.
        Parameters:
        variableName - the new variable name
        Throws:
        IllegalArgumentException - if:
        • the node belongs to a different AST
        • the node already has a parent
      • getExtraDimensions

        public int getExtraDimensions()
        Returns the number of extra array dimensions over and above the explicitly-specified type.

        For example, int x[][] has a type of int and two extra array dimensions; int[][] x has a type of int[][] and zero extra array dimensions. The two constructs have different ASTs, even though there are really syntactic variants of the same variable declaration.

        In the JLS8 API, this method is a convenience method that counts extraDimensions().

        Returns:
        the number of extra array dimensions
        Since:
        2.1
      • setExtraDimensions

        public void setExtraDimensions​(int dimensions)
        Deprecated.
        In the JLS8 API, this method is replaced by extraDimensions() which contains a list of Dimension nodes.
        Sets the number of extra array dimensions over and above the explicitly-specified type.

        For example, int x[][] has a type of int and two extra array dimensions; int[][] x has a type of int[][] and zero extra array dimensions. The two constructs have different ASTs, even though there are really syntactic variants of the same variable declaration.

        Parameters:
        dimensions - the number of array dimensions
        Throws:
        IllegalArgumentException - if the number of dimensions is negative
        UnsupportedOperationException - if this operation is used in a JLS8 or later AST
        Since:
        2.1
      • extraDimensions

        public List extraDimensions()
        Returns the live ordered list of extra dimensions with optional annotations (added in JLS8 API).
        Returns:
        the live list of extra dimensions with optional annotations (element type: Dimension)
        Throws:
        UnsupportedOperationException - if this operation is used below JLS8
        Since:
        3.10
      • getInitializer

        public Expression getInitializer()
        Returns the initializer of this variable declaration, or null if there is none.
        Returns:
        the initializer expression node, or null if there is none
      • setInitializer

        public void setInitializer​(Expression initializer)
        Sets or clears the initializer of this variable declaration.
        Parameters:
        initializer - the initializer expression node, or null if there is none
        Throws:
        IllegalArgumentException - if:
        • the node belongs to a different AST
        • the node already has a parent
        • a cycle in would be created
      • resolveBinding

        public IVariableBinding resolveBinding()
        Resolves and returns the binding for the variable declared in this variable declaration.

        Note that bindings are generally unavailable unless requested when the AST is being built.

        Returns:
        the binding, or null if the binding cannot be resolved