Class JsArray<T extends JavaScriptObject>

  • Type Parameters:
    T - the concrete type of object contained in this array

    public class JsArray<T extends JavaScriptObject>
    extends JavaScriptObject
    A simple wrapper around a homogeneous native array of JavaScriptObject values. This class may not be directly instantiated, and can only be returned from a native method. For example, native JsArray getNativeArray() /*-{ return [ { x: 0, y: 1}, { x: 2, y: 3}, { x: 4, y: 5}, ]; }-* /;
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected JsArray()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      T get​(int index)
      Gets the object at a given index.
      java.lang.String join()
      Convert each element of the array to a String and join them with a comma separator.
      java.lang.String join​(java.lang.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.
      void push​(T value)
      Pushes the given value onto the end of the array.
      void set​(int index, T value)
      Sets the object value at a given index.
      void setLength​(int newLength)
      Reset the length of the array.
      T shift()
      Shifts the first value off the array.
      void unshift​(T value)
      Shifts a value onto the beginning of the array.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • JsArray

        protected JsArray()
    • Method Detail

      • get

        public final T get​(int index)
        Gets the object at a given index.
        Parameters:
        index - the index to be retrieved
        Returns:
        the object at the given index, or null if none exists
      • join

        public final java.lang.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

        public final java.lang.String join​(java.lang.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

        public final int length()
        Gets the length of the array.
        Returns:
        the array length
      • push

        public final void push​(T value)
        Pushes the given value onto the end of the array.
      • set

        public final void set​(int index,
                              T value)
        Sets the object 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 object.
        Parameters:
        index - the index to be set
        value - the object to be stored
      • setLength

        public final void setLength​(int newLength)
        Reset the length of the array.
        Parameters:
        newLength - the new length of the array
      • shift

        public final T shift()
        Shifts the first value off the array.
        Returns:
        the shifted value
      • unshift

        public final void unshift​(T value)
        Shifts a value onto the beginning of the array.
        Parameters:
        value - the value to the stored