com.github.gwtd3.api.arrays

Class Array<T>

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.arrays.Array<T>

Type Parameters:

T -

Direct Known Subclasses:

DsvRows, Polygon

public class Array<T>
extends com.google.gwt.core.client.JavaScriptObject

A Javascript object wrapping an array-like structure.

Although strong typed with a generic type, the array may in fact contains any value type.

Use factory methods (fromInts(int...), ... ) to create Array instance from primitive values.

You may turn a Java Iterable instance to an array using the fromIterable(Iterable) method.

This class provides the properties and methods defined on this page

Author:

Anthony Schiochet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Array()

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<Value>	asIterable()
List<T>	asList()
Array<?>	concat(Array<?> array1) Return a new array containing the values of this array and the given array.
Array<?>	concat(Array<?> array1, Array<?> array2) Return a new array containing the values of this array and the given array.
Array<?>	concat(Array<?> array1, Array<?> array2, Array<?> array3) Return a new array containing the values of this array and the given array.
Array<?>	concat(Array<?> array1, Array<?> array2, Array<?> array3, Array<?> array4) Return a new array containing the values of this array and the given array.
Array<?>	concat(Array<?> array1, Array<?> array2, Array<?> array3, Array<?> array4, Array<?> array5) Return a new array containing the values of this array and the given array.
static <R> Array<R>	create() Create a new empty array.
boolean	every(ForEachCallback<Boolean> callback) Executes the provided callback function once for each element present in the array until it finds one where callback returns a falsy value.
boolean	every(ForEachCallback<Boolean> callback, Object thisArg) Executes the provided callback function once for each element present in the array until it finds one where callback returns a falsy value.
Array<T>	filter(ForEachCallback<Boolean> callback) Calls the provided callback function once for each element in an array, and constructs a new array of all the values for which callback returns a true value.
Array<T>	filter(ForEachCallback<Boolean> callback, Object thisArg) Calls the provided callback function once for each element in an array, and constructs a new array of all the values for which callback returns a true value.
void	forEach(ForEachCallback<Void> callback) Executes the provided callback once for each element of the array with an assigned value.
void	forEach(ForEachCallback<Void> callback, Object thisArg) Executes the provided callback once for each element of the array with an assigned value.
static Array<Byte>	fromBytes(byte... args) Create a new Array from the given values.
static Array<Character>	fromChars(char... args) Create a new Array from the given values.
static Array<Double>	fromDoubles(double... args) Create a new Array from the given values.
static Array<Float>	fromFloats(float... args) Create a new Array from the given values.
static Array<Integer>	fromInts(int... args) Create a new Array from the given values.
static <T> Array<T>	fromIterable(Iterable<T> iterable) Create a new Array from the given iterable.
static Array<Object>	fromJavaArray(Object[] args) Create a new Array from the given values.
static Array<Long>	fromLongs(long... args) Create a new Array from the given values.
static <R> Array<R>	fromObjects(R... args) Create a new Array from the given values.
static Array<Short>	fromShorts(short... args) Create a new Array from the given values.
T	get(int index) Return the element at the specified index as the parameterized type.
boolean	getBoolean(int i) Return the item at the index i.
int	getInt(int index) Return the item at the index i.
double	getNumber(int index) Return the item at the index i.
T	getObject(int i) Return the item at the index i.
String	getString(int i) Return the item at the index i.
Value	getValue(int i) Return the element at the given index wrapped by a Value object.
<R> int	indexOf(R item) Search the array for the specified item, and returns its position, or -1 of the item is not found.
<R> int	indexOf(R item, int startIndex) Search the array for the specified item, and returns its position, or -1 of the item is not found.
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 the given separator.
<R> int	lastIndexOf(R item) Search the array for the specified item, and returns its position, or -1 of the item is not found.
<R> int	lastIndexOf(R item, int startIndex) Search the array for the specified item, and returns its position, or -1 of the item is not found.
int	length() Gets the length of the array.
<R> Array<R>	map(ForEachCallback<R> callback) Calls the provided callback function once for each element in the array, and constructs a new array of all the values returned by the callback.
<R> Array<R>	map(ForEachCallback<R> callback, Object thisArg) Calls the provided callback function once for each element in the array, and constructs a new array of all the values returned by the callback.
<R> Array<R>	map(com.google.gwt.core.client.JavaScriptObject callback) Alias for map(ForEachCallback).
T	pop() Removes the last element of an array, and returns that element.
boolean	popBoolean() Removes the last element of an array, and returns that element.
double	popNumber() Removes the last element of an array, and returns that element.
<R extends com.google.gwt.core.client.JavaScriptObject> R	popObject() Removes the last element of an array, and returns that element.
String	popString() Removes the last element of an array, and returns that element.
int	push(boolean value) Pushes the given boolean onto the end of the array.
int	push(double value) Pushes the given double onto the end of the array.
int	push(com.google.gwt.core.client.JavaScriptObject value) Pushes the given JavaScriptObject onto the end of the array.
int	push(T value) Pushes the given item onto the end of the array.
Array<T>	reverse() Reverse the order of the elements in the array.
void	set(int index, boolean value) Sets the boolean value at a given index.
void	set(int index, double value) Sets the double value at a given index.
void	set(int index, com.google.gwt.core.client.JavaScriptObject value) Sets the object value at a given index.
void	set(int index, String value) Sets the String value at a given index.
void	set(int index, T value) Sets the value at a given index.
void	setLength(int newLength) Reset the length of the array.
boolean	shiftBoolean() Shifts the first value off the array.
double	shiftNumber() Shifts the first value off the array.
<R extends com.google.gwt.core.client.JavaScriptObject> R	shiftObject() Shifts the first value off the array.
String	shiftString() Shifts the first value off the array.
Array<T>	slice(int startIndex) Selects the elements starting at the given startIndex, until the last element, and return the selected elements in a new array.
Array<T>	slice(int startIndex, int endIndex) Selects the elements starting at the given startIndex, extending at the element just before the endIndex, and return the selected elements in a new array.
boolean	some(ForEachCallback<Boolean> callback) Executes the provided callback function once for each element present in the array until it finds one where callback returns a true value.
boolean	some(ForEachCallback<Boolean> callback, Object thisArg) Executes the provided callback function once for each element present in the array until it finds one where callback returns a true value.
Array<?>	sortAlphaAsc() Sort the elements alphabetically and ascending.
Array<?>	sortAlphaDesc() Sort the elements alphabetically and descending.
Array<?>	sortNumericAsc() Sort the elements numerically and ascending.
Array<?>	sortNumericDesc() Sort the elements numerically and ascending.
Array<T>	splice(int startIndex, int count) Remove count elements from startIndex.
Array<T>	splice(int startIndex, int count, Object insert1) Remove count elements from startIndex, and insert the given elements at this position.
Array<T>	splice(int startIndex, int count, Object insert1, Object insert2) Remove count elements from startIndex, and insert the given elements at this position.
Array<T>	splice(int startIndex, int count, Object insert1, Object insert2, Object insert3) Remove count elements from startIndex, and insert the given elements at this position.
Array<T>	splice(int startIndex, int count, Object insert1, Object insert2, Object insert3, Object insert4) Remove count elements from startIndex, and insert the given elements at this position.
Array<T>	splice(int startIndex, int count, Object insert1, Object insert2, Object insert3, Object insert4, Object insert5) Remove count elements from startIndex, and insert the given elements at this position.
int	unshift(boolean value) Shifts a boolean onto the beginning of the array.
int	unshift(double value) Shifts a double onto the beginning of the array.
int	unshift(com.google.gwt.core.client.JavaScriptObject value) Shifts a JavaScriptObject onto the beginning of the array.
int	unshift(String value) Shifts a String 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

Array

protected Array()

Method Detail

fromIterable

public static <T> Array<T> fromIterable(Iterable<T> iterable)

Create a new Array from the given iterable.

Parameters:

iterable - the iterable

Returns:

the array

create

public static <R> Array<R> create()

Create a new empty array.

Returns:

the array

fromInts

public static final Array<Integer> fromInts(int... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromBytes

public static final Array<Byte> fromBytes(byte... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromChars

public static Array<Character> fromChars(char... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromDoubles

public static final Array<Double> fromDoubles(double... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromFloats

public static final Array<Float> fromFloats(float... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromLongs

public static final Array<Long> fromLongs(long... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromShorts

public static final Array<Short> fromShorts(short... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromObjects

public static final <R> Array<R> fromObjects(R... args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

fromJavaArray

public static final Array<Object> fromJavaArray(Object[] args)

Create a new Array from the given values.

Parameters:

args - the values

Returns:

the new array

get

public final T get(int index)

Return the element at the specified index as the parameterized type.

Parameters:

index - the index of the object

Returns:

the

getValue

public final Value getValue(int i)

Return the element at the given index wrapped by a Value object.

Parameters:

i - the index

Returns:

the element as a Value

getObject

public final T getObject(int i)

Return the item at the index i.

Parameters:

i - the index of the item

Returns:

the item

getBoolean

public final boolean getBoolean(int i)

Return the item at the index i.

Parameters:

i - the index of the item

Returns:

the item

getString

public final String getString(int i)

Return the item at the index i.

Parameters:

i - the index of the item

Returns:

the item

getNumber

public final double getNumber(int index)

Return the item at the index i.

Parameters:

i - the index of the item

Returns:

the item

getInt

public final int getInt(int index)

Return the item at the index i.

Parameters:

i - the index of the item

Returns:

the item

pop

public final T pop()

Removes the last element of an array, and returns that element. Note: This method changes the length of an array.

Returns:

the item

popBoolean

public final boolean popBoolean()

Removes the last element of an array, and returns that element. Note: This method changes the length of an array.

Returns:

the item

popString

public final String popString()

Removes the last element of an array, and returns that element. Note: This method changes the length of an array.

Returns:

the item

popNumber

public final double popNumber()

Removes the last element of an array, and returns that element. Note: This method changes the length of an array.

Returns:

the item

popObject

public final <R extends com.google.gwt.core.client.JavaScriptObject> R popObject()

Removes the last element of an array, and returns that element. Note: This method changes the length of an array.

Returns:

the item

indexOf

public final <R> int indexOf(R item)

Search the array for the specified item, and returns its position, or -1 of the item is not found.

The search will start at the index 0, and end the search at the end of the array.

Parameters:

item - the item to search for.

Returns:

the index of the item or -1.

indexOf

public final <R> int indexOf(R item,
              int startIndex)

Search the array for the specified item, and returns its position, or -1 of the item is not found.

The search will start at the specified position, and end the search at the end of the array.
Negative values will start at the given position counting from the end, and search to the end.

Parameters:

item - the item to search for.

startIndex - the start of the search

Returns:

the index of the item or -1.

lastIndexOf

public final <R> int lastIndexOf(R item)

Search the array for the specified item, and returns its position, or -1 of the item is not found.

The search will start at the end of the array, and end the search at the beginning of the array.

Parameters:

item - the item to search for.

Returns:

the index of the item or -1.

lastIndexOf

public final <R> int lastIndexOf(R item,
                  int startIndex)

Search the array for the specified item, and returns its position, or -1 of the item is not found.

The search will start at the specified position, and end the search at the beginning of the array.
Negative values will start at the given position counting from the end, and search to the beginning.

Parameters:

item - the item to search for.

startIndex - the start of the search

Returns:

the index of the item or -1.

concat

public final Array<?> concat(Array<?> array1)

Return a new array containing the values of this array and the given array.

Parameters:

array1 -

Returns:

the new array

concat

public final Array<?> concat(Array<?> array1,
              Array<?> array2)

Return a new array containing the values of this array and the given array.

Parameters:

array1 -

array2 -

Returns:

concat

public final Array<?> concat(Array<?> array1,
              Array<?> array2,
              Array<?> array3)

Return a new array containing the values of this array and the given array.

Parameters:

array1 -

array2 -

array3 -

Returns:

concat

public final Array<?> concat(Array<?> array1,
              Array<?> array2,
              Array<?> array3,
              Array<?> array4)

Return a new array containing the values of this array and the given array.

Parameters:

array1 -

array2 -

array3 -

array4 -

Returns:

concat

public final Array<?> concat(Array<?> array1,
              Array<?> array2,
              Array<?> array3,
              Array<?> array4,
              Array<?> array5)

Return a new array containing the values of this array and the given array.

Parameters:

array1 -

array2 -

array3 -

array4 -

array5 -

Returns:

forEach

public final void forEach(ForEachCallback<Void> callback)

Executes the provided callback once for each element of the array with an assigned value. It is not invoked for indexes which have been deleted or which have been initialized to undefined.

Parameters:

callback -

forEach

public final void forEach(ForEachCallback<Void> callback,
           Object thisArg)

Executes the provided callback once for each element of the array with an assigned value. It is not invoked for indexes which have been deleted or which have been initialized to undefined.

Parameters:

callback -

every

public final boolean every(ForEachCallback<Boolean> callback)

Executes the provided callback function once for each element present in the array until it finds one where callback returns a falsy value. If such an element is found, the every method immediately returns false. Otherwise, if callback returned a true value for all elements, every will return true.

callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

Returns:

true if the callback returned true for all elements, false otherwise.

every

public final boolean every(ForEachCallback<Boolean> callback,
            Object thisArg)

Executes the provided callback function once for each element present in the array until it finds one where callback returns a falsy value. If such an element is found, the every method immediately returns false. Otherwise, if callback returned a true value for all elements, every will return true.

callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

thisArg - an argument to be passed to each callback invocations.

Returns:

true if the callback returned true for all elements, false otherwise.

some

public final boolean some(ForEachCallback<Boolean> callback)

Executes the provided callback function once for each element present in the array until it finds one where callback returns a true value. If such an element is found, the method immediately returns true. Otherwise, some will return false.

callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

Returns:

true if the callback returned true for all elements, false otherwise.

some

public final boolean some(ForEachCallback<Boolean> callback,
           Object thisArg)

Executes the provided callback function once for each element present in the array until it finds one where callback returns a true value. If such an element is found, the method immediately returns true. Otherwise, some will return false.

callback is invoked only for indexes of the array which have assigned values;
it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

thisArg - an argument to be passed to each callback invocations.

Returns:

true if the callback returned true for one element, false otherwise.

filter

public final Array<T> filter(ForEachCallback<Boolean> callback)

Calls the provided callback function once for each element in an array, and constructs a new array of all the values for which callback returns a true value. Array elements which do not pass the callback test are simply skipped, and are not included in the new array.

callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

Returns:

a new array containing only the element for which the callback returned true.

filter

public final Array<T> filter(ForEachCallback<Boolean> callback,
              Object thisArg)

Calls the provided callback function once for each element in an array, and constructs a new array of all the values for which callback returns a true value. Array elements which do not pass the callback test are simply skipped, and are not included in the new array.

callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

thisArg - an argument to be passed to each callback invocations.

Returns:

a new array containing only the element for which the callback returned true.

map

public final <R> Array<R> map(ForEachCallback<R> callback)

Calls the provided callback function once for each element in the array, and constructs a new array of all the values returned by the callback.

callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

Returns:

a new array containing the elements returned by the callback

map

public final <R> Array<R> map(com.google.gwt.core.client.JavaScriptObject callback)

Alias for map(ForEachCallback).

Parameters:

callback - the callback to be called for each element

Returns:

a new array containing the elements returned by the callback

map

public final <R> Array<R> map(ForEachCallback<R> callback,
               Object thisArg)

Calls the provided callback function once for each element in the array, and constructs a new array of all the values returned by the callback.

callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Parameters:

callback - the callback to be called for each element

thisArg - an argument to be passed to each callback invocations.

Returns:

a new array containing the elements returned by the callback

join

public final 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 String join(String separator)

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

Parameters:

separator - the separator to be used between each joined element

length

public final int length()

Gets the length of the array.

Returns:

the array length

setLength

public final void setLength(int newLength)

Reset the length of the array.

Parameters:

newLength - the new length of the array

push

public final int push(boolean value)

Pushes the given boolean onto the end of the array.

Parameters:

value - the item to push

Returns:

the new length of the array

push

public final int push(double value)

Pushes the given double onto the end of the array.

Parameters:

value - the item to push

Returns:

the new length of the array

push

public final int push(com.google.gwt.core.client.JavaScriptObject value)

Pushes the given JavaScriptObject onto the end of the array.

Parameters:

value - the item to push

Returns:

the new length of the array

push

public final int push(T value)

Pushes the given item onto the end of the array.

Parameters:

value - the item to push

Returns:

the new length of the array

set

public final void set(int index,
       boolean value)

Sets the boolean 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 boolean to be stored

set

public final void set(int index,
       T value)

Sets the 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 boolean to be stored

set

public final void set(int index,
       double value)

Sets the double 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 double to be stored

set

public final void set(int index,
       com.google.gwt.core.client.JavaScriptObject 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 JavaScriptObject to be stored

set

public final void set(int index,
       String value)

Sets the String 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 String.

Parameters:

index - the index to be set

value - the String to be stored

shiftBoolean

public final boolean shiftBoolean()

Shifts the first value off the array.

Returns:

the shifted boolean

shiftNumber

public final double shiftNumber()

Shifts the first value off the array.

Returns:

the shifted double

shiftObject

public final <R extends com.google.gwt.core.client.JavaScriptObject> R shiftObject()

Shifts the first value off the array.

Returns:

the shifted JavaScriptObject

shiftString

public final String shiftString()

Shifts the first value off the array.

Returns:

the shifted String

unshift

public final int unshift(boolean value)

Shifts a boolean onto the beginning of the array.

Parameters:

value - the value to the stored

unshift

public final int unshift(double value)

Shifts a double onto the beginning of the array.

Parameters:

value - the value to store

unshift

public final int unshift(com.google.gwt.core.client.JavaScriptObject value)

Shifts a JavaScriptObject onto the beginning of the array.

Parameters:

value - the value to store

unshift

public final int unshift(String value)

Shifts a String onto the beginning of the array.

Parameters:

value - the value to store

reverse

public final Array<T> reverse()

Reverse the order of the elements in the array.

Returns:

the array after it has been reversed

slice

public final Array<T> slice(int startIndex)

Selects the elements starting at the given startIndex, until the last element, and return the selected elements in a new array.

Parameters:

startIndex -

Returns:

the new array

slice

public final Array<T> slice(int startIndex,
             int endIndex)

Selects the elements starting at the given startIndex, extending at the element just before the endIndex, and return the selected elements in a new array.

Parameters:

startIndex -

endIndex -

Returns:

the new array

sortAlphaAsc

public final Array<?> sortAlphaAsc()

Sort the elements alphabetically and ascending.

Returns:

the array with sorted elements.

sortAlphaDesc

public final Array<?> sortAlphaDesc()

Sort the elements alphabetically and descending.

Returns:

the array with sorted elements.

sortNumericAsc

public final Array<?> sortNumericAsc()

Sort the elements numerically and ascending.

Returns:

the array with sorted elements.

sortNumericDesc

public final Array<?> sortNumericDesc()

Sort the elements numerically and ascending.

Returns:

the array with sorted elements.

splice

public final Array<T> splice(int startIndex,
              int count)

Remove count elements from startIndex.

Parameters:

startIndex - the index of the first element to be removed; negative values specify position from the end of the array

count - the number of elements to be removed

Returns:

the removed elements

splice

public final Array<T> splice(int startIndex,
              int count,
              Object insert1)

Remove count elements from startIndex, and insert the given elements at this position.

Parameters:

startIndex - the index of the first element to be removed; negative values specify position from the end of the array

count - the number of elements to be removed

insert1 - element to insert

Returns:

the removed elements

splice

public final Array<T> splice(int startIndex,
              int count,
              Object insert1,
              Object insert2)

Remove count elements from startIndex, and insert the given elements at this position.

Parameters:

startIndex - the index of the first element to be removed; negative values specify position from the end of the array

count - the number of elements to be removed

insert1 - element to insert

insert2 - element to insert

Returns:

the removed elements

splice

public final Array<T> splice(int startIndex,
              int count,
              Object insert1,
              Object insert2,
              Object insert3)

Remove count elements from startIndex, and insert the given elements at this position.

Parameters:

startIndex - the index of the first element to be removed; negative values specify position from the end of the array

count - the number of elements to be removed

insert1 - element to insert

insert2 - element to insert

insert3 - element to insert

Returns:

the removed elements

splice

public final Array<T> splice(int startIndex,
              int count,
              Object insert1,
              Object insert2,
              Object insert3,
              Object insert4)

Remove count elements from startIndex, and insert the given elements at this position.

Parameters:

startIndex - the index of the first element to be removed; negative values specify position from the end of the array

count - the number of elements to be removed

insert1 - element to insert

insert2 - element to insert

insert3 - element to insert

insert4 - element to insert

Returns:

the removed elements

splice

public final Array<T> splice(int startIndex,
              int count,
              Object insert1,
              Object insert2,
              Object insert3,
              Object insert4,
              Object insert5)

Remove count elements from startIndex, and insert the given elements at this position.

Parameters:

startIndex - the index of the first element to be removed; negative values specify position from the end of the array

count - the number of elements to be removed

insert1 - element to insert

insert2 - element to insert

insert3 - element to insert

insert4 - element to insert

insert5 - element to insert

Returns:

the removed elements

asList

public final List<T> asList()

Returns:

a list wrapping the array to access

asIterable

public final Iterable<Value> asIterable()