JsArrayOf (GWT Elemental 2.7.0)

java.lang.Object
- com.google.gwt.core.client.JavaScriptObject
- - elemental.js.util.JsArrayOf<T>

All Implemented Interfaces:: ArrayOf<T>

public final class JsArrayOf<T>
extends com.google.gwt.core.client.JavaScriptObject
implements ArrayOf<T>

JavaScript native implementation of ArrayOf.

Constructor Summary

Constructors
Modifier Constructor and Description

protected JsArrayOf()

Constructors
Modifier	Constructor and Description
`protected`	`JsArrayOf()`

Method Summary

Methods
Modifier and Type	Method and Description
`JsArrayOf<T>`	`concat(ArrayOf<T> values)` Returns a new array that is the concatenation of this array and `values`.
`boolean`	`contains(T value)` Indicates whether the array contains the specified value.
`static <T> JsArrayOf<T>`	`create()` Create a new empty Array instance.
`T`	`get(int index)` Gets the value at a given index.
`int`	`indexOf(T value)` Returns the index of the specified value or `-1` if the value is not found.
`void`	`insert(int index, T 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.
`T`	`peek()` Returns the last value of the array;
`T`	`pop()` Remove and return the element from the end of the array.
`void`	`push(T value)` Pushes the given value onto the end of the array.
`void`	`remove(T 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, T value)` sets the value 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`	`sort(CanCompare<T> comparator)` Sorts the contents of the Array based on the `CanCompare`.
`JsArrayOf<T>`	`splice(int index, int count)` Removes the specified number of elements starting at index and returns the removed elements.
`void`	`unshift(T value)` Shifts a value onto the beginning of the array.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JsArrayOf
```
protected JsArrayOf()
```
- Method Detail
  - create
```
public static <T> JsArrayOf<T> create()
```
    Create a new empty Array instance.
  - concat
```
public JsArrayOf<T> concat(ArrayOf<T> values)
```
    Description copied from interface: ArrayOf
    
    Returns a new array that is the concatenation of this array and values. This method does not mutate the current array.
    
    Specified by:
    
    concat in interface ArrayOf<T>
  - contains
```
public boolean contains(T value)
```
    Description copied from interface: ArrayOf
    
    Indicates whether the array contains the specified value.
    
    Specified by:
    
    contains in interface ArrayOf<T>
  - get
```
public T get(int index)
```
    Description copied from interface: ArrayOf
    
    Gets the value at a given index.
    
    Specified by:
    
    get in interface ArrayOf<T>
    
    Parameters:
    index - the index to be retrieved
    
    Returns:
    the value at the given index
  - indexOf
```
public int indexOf(T value)
```
    Description copied from interface: ArrayOf
    
    Returns the index of the specified value or -1 if the value is not found.
    
    Specified by:
    
    indexOf in interface ArrayOf<T>
  - insert
```
public void insert(int index,
          T value)
```
    Description copied from interface: ArrayOf
    
    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.
    
    Specified by:
    
    insert in interface ArrayOf<T>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: ArrayOf
    
    Returns true if the length of the array is zero.
    
    Specified by:
    
    isEmpty in interface ArrayOf<T>
    
    Returns:
    true when length is zero
  - join
```
public 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.
    
    Specified by:
    
    join in interface ArrayOf<T>
  - join
```
public String join(String separator)
```
    Description copied from interface: ArrayOf
    
    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.
    
    Specified by:
    
    join in interface ArrayOf<T>
  - length
```
public int length()
```
    Description copied from interface: ArrayOf
    
    Gets the length of the array.
    
    Specified by:
    
    length in interface ArrayOf<T>
    
    Returns:
    the array length
  - peek
```
public T peek()
```
    Description copied from interface: ArrayOf
    
    Returns the last value of the array;
    
    Specified by:
    
    peek in interface ArrayOf<T>
    
    Returns:
    the last value
  - pop
```
public T pop()
```
    Description copied from interface: ArrayOf
    
    Remove and return the element from the end of the array.
    
    Specified by:
    
    pop in interface ArrayOf<T>
    
    Returns:
    the removed value
  - push
```
public void push(T value)
```
    Pushes the given value onto the end of the array.
    
    Specified by:
    
    push in interface ArrayOf<T>
  - remove
```
public void remove(T value)
```
    Description copied from interface: ArrayOf
    
    Searches for the specified value in the array and removes the first occurrence if found.
    
    Specified by:
    
    remove in interface ArrayOf<T>
  - removeByIndex
```
public void removeByIndex(int index)
```
    Description copied from interface: ArrayOf
    
    Removes the element at the specified index.
    
    Specified by:
    
    removeByIndex in interface ArrayOf<T>
  - set
```
public void set(int index,
       T value)
```
    Description copied from interface: ArrayOf
    
    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.
    
    Specified by:
    
    set in interface ArrayOf<T>
    
    Parameters:
    index - the index to be set
    value - the value to be stored
  - setLength
```
public void setLength(int newLength)
```
    Description copied from interface: ArrayOf
    
    Reset the length of the array.
    
    Specified by:
    
    setLength in interface ArrayOf<T>
    
    Parameters:
    newLength - the new length of the array
  - shift
```
public T shift()
```
    Description copied from interface: ArrayOf
    
    Shifts the first value off the array.
    
    Specified by:
    
    shift in interface ArrayOf<T>
    
    Returns:
    the shifted value
  - sort
```
public void sort(CanCompare<T> comparator)
```
    Description copied from interface: ArrayOf
    
    Sorts the contents of the Array based on the CanCompare.
    
    Specified by:
    
    sort in interface ArrayOf<T>
  - splice
```
public JsArrayOf<T> splice(int index,
                  int count)
```
    Description copied from interface: ArrayOf
    
    Removes the specified number of elements starting at index and returns the removed elements.
    
    Specified by:
    
    splice in interface ArrayOf<T>
  - unshift
```
public void unshift(T value)
```
    Description copied from interface: ArrayOf
    
    Shifts a value onto the beginning of the array.
    
    Specified by:
    
    unshift in interface ArrayOf<T>
    
    Parameters:
    value - the value to the stored

Class JsArrayOf<T>

Constructor Summary

Method Summary

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

Methods inherited from class java.lang.Object

Constructor Detail

JsArrayOf

Method Detail

create

concat

contains

get

indexOf

insert

isEmpty

join

join

length

peek

pop

push

remove

removeByIndex

set

setLength

shift

sort

splice

unshift