Class ArrayType


  • public class ArrayType
    extends Type
    Type node for an array type.

    In JLS8 and later, array types are represented by a base element type (which cannot be an array type) and a list of dimensions, each of which may have a list of annotations.

     ArrayType: 
        Type Dimension { Dimension }
     
    In JLS4 and before, array types were expressed in a recursive manner, one dimension at a time:
     ArrayType:
        Type [ ]
    This structure became untenable with the advent of type-use annotations, because in the language model, the base type binds with array dimensions from right to left, whereas a recursive structure binds from left to right (inside out).

    Example:
    int @A[] @B[] @C[] is an @A-array of
    int      @B[] @C[], but such a component type is not representable by nested ArrayTypes with contiguous source ranges.

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

      • ELEMENT_TYPE_PROPERTY

        public static final ChildPropertyDescriptor ELEMENT_TYPE_PROPERTY
        The "elementType" structural property of this node type (child type: Type) (added in JLS8 API). Cannot be an array type.
        Since:
        3.10
      • DIMENSIONS_PROPERTY

        public static final ChildListPropertyDescriptor DIMENSIONS_PROPERTY
        The "dimensions" structural property of this node type (element type: Dimension) (added in JLS8 API).
        Since:
        3.10
    • Method Detail

      • 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
      • getComponentType

        public Type getComponentType()
        Deprecated.
        In the JLS8 API, the recursive structure is not valid.
        Returns the component type of this array type. The component type may be another array type.
        Returns:
        the component type node
        Throws:
        UnsupportedOperationException - if this operation is used in an AST later than JLS4
        See Also:
        dimensions()
      • setComponentType

        public void setComponentType​(Type componentType)
        Deprecated.
        In the JLS8 API, the recursive structure is not valid.
        Sets the component type of this array type. The component type may be another array type.
        Parameters:
        componentType - the component type
        Throws:
        IllegalArgumentException - if:
        • the node belongs to a different AST
        • the node already has a parent
        • a cycle in would be created
        UnsupportedOperationException - if this operation is used in an AST later than JLS4
      • getElementType

        public Type getElementType()
        Returns the element type of this array type. The element type is never an array type.

        In JLS4 and earlier, this is a convenience method that descends a chain of nested array types until it reaches a non-array type.

        Returns:
        the element type node
      • setElementType

        public void setElementType​(Type type)
        Sets the element type of the array.
        Parameters:
        type - the new type
        Throws:
        IllegalArgumentException - if:
        • the node belongs to a different AST
        • the node already has a parent
        • the node is an array type
        UnsupportedOperationException - if this operation is used below JLS8
        Since:
        3.10
      • getDimensions

        public int getDimensions()
        Returns the number of dimensions in this array type.

        In JLS8 and later, this is a convenience method that returns dimensions().size().

        In JLS4 and earlier, this is a convenience method that descends a chain of nested array types until it reaches a non-array type.

        Returns:
        the number of dimensions (always positive)
      • dimensions

        public List dimensions()
        Returns the live ordered list of dimensions with optional annotations (added in JLS8 API).

        For the array type to be plausible, the list should contain at least one element.

        Returns:
        the live list of dimensions with optional annotations (element type: Dimension)
        Throws:
        UnsupportedOperationException - if this operation is used below JLS8
        Since:
        3.10