elemental.util.

Interface ArrayOfString


  • public interface ArrayOfString

    A lightweight array of Strings.

    See Also:

    JsArrayOfString

    • Method Summary

      All Methods
      Modifier and Type Method and Description
      ArrayOfString concat(ArrayOfString values)

      Returns a new array that is the concatenation of this array and values.
      boolean contains(String value)

      Indicates whether the array contains the specified value.
      String get(int index)

      Gets the value at a given index.
      int indexOf(String value)

      Returns the index of the specified value or -1 if the value is not found.
      void insert(int index, String value)

      Inserts a new element into the array at the specified index.
      boolean isEmpty()

      Returns true if the length of the array is zero.
      String join()

      Convert each element of the array to a String and join them with a comma separator.
      String join(String separator)

      Convert each element of the array to a String and join them with a comma separator.
      int length()

      Gets the length of the array.
      String peek()

      Returns the last value of the array;
      String pop()

      Remove and return the element from the end of the array.
      void push(String value)

      Pushes the given value onto the end of the array.
      void remove(String value)

      Searches for the specified value in the array and removes the first occurrence if found.
      void removeByIndex(int index)

      Removes the element at the specified index.
      void set(int index, String value)

      Sets the value value at a given index.
      void setLength(int length)

      Reset the length of the array.
      String shift()

      Shifts the first value off the array.
      void sort()

      Sorts the contents of the array in ascending order.
      void sort(CanCompareString comparator)

      Sorts the contents of the Array based on the CanCompareString.
      ArrayOfString splice(int index, int count)

      Removes the specified number of elements starting at index and returns the removed elements.
      void unshift(String value)

      Shifts a value onto the beginning of the array.

    • Method Detail

      • concat

        ArrayOfString concat(ArrayOfString values)

        Returns a new array that is the concatenation of this array and values. This method does not mutate the current array.

      • contains

        boolean contains(String value)

        Indicates whether the array contains the specified value.

      • get

        String get(int index)

        Gets the value at a given index.

        Parameters:

        index - the index to be retrieved

        Returns:

        the value at the given index, or null if none exists

      • indexOf

        int indexOf(String value)

        Returns the index of the specified value or -1 if the value is not found.

      • insert

        void insert(int index,
            String value)

        Inserts a new element into the array at the specified index. Note: If index >= the length of the array, the element will be appended to the end. Also if the index is negative, the element will be inserted starting from the end of the array.

      • isEmpty

        boolean isEmpty()

        Returns true if the length of the array is zero.

        Returns:

        true when length is zero

      • join

        String join()

        Convert each element of the array to a String and join them with a comma separator. The value returned from this method may vary between browsers based on how JavaScript values are converted into strings.

      • join

        String join(String separator)

        Convert each element of the array to a String and join them with a comma separator. The value returned from this method may vary between browsers based on how JavaScript values are converted into strings.

      • length

        int length()

        Gets the length of the array.

        Returns:

        the array length

      • peek

        String peek()

        Returns the last value of the array;

        Returns:

        the last value

      • pop

        String pop()

        Remove and return the element from the end of the array.

        Returns:

        the removed value

      • push

        void push(String value)

        Pushes the given value onto the end of the array.

      • remove

        void remove(String value)

        Searches for the specified value in the array and removes the first occurrence if found.

      • removeByIndex

        void removeByIndex(int index)

        Removes the element at the specified index.

      • set

        void set(int index,
         String value)

        Sets the value value at a given index. If the index is out of bounds, the value will still be set. The array's length will be updated to encompass the bounds implied by the added value.

        Parameters:

        index - the index to be set

        value - the value to be stored

      • setLength

        void setLength(int length)

        Reset the length of the array.

        Parameters:

        length - the new length of the array

      • shift

        String shift()

        Shifts the first value off the array.

        Returns:

        the shifted value

      • sort

        void sort()

        Sorts the contents of the array in ascending order.

      • splice

        ArrayOfString splice(int index,
                     int count)

        Removes the specified number of elements starting at index and returns the removed elements.

      • unshift

        void unshift(String value)

        Shifts a value onto the beginning of the array.

        Parameters:

        value - the value to the stored