net.java.html.lib

Class Array<T>

java.lang.Object

net.java.html.lib.Objs

net.java.html.lib.Array<T>

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

RegExpExecArray, RegExpMatchArray, TemplateStringsArray

public class Array<T>
extends Objs
implements Iterable<T>

Nested Class Summary

Nested classes/interfaces inherited from class net.java.html.lib.Objs

Objs.Constructor<T extends Objs>, Objs.Property<T>

Field Summary

Fields

Modifier and Type	Field and Description
Objs.Property<Number>	length Gets or sets the length of the array.
static Array<Object>	prototype

Constructor Summary

Constructors

Modifier	Constructor and Description
	Array()
	Array(double arrayLength)
protected	Array(Objs.Constructor<?> constructor, Object js)
	Array(T... items)

Method Summary

Modifier and Type	Method and Description
static Array<?>	$as(Object obj) Casts given object to this class.
T	$get(double index) Gets an item from the array.
Array<T>	$set(double index, Object value) Sets a value at index in the array.
Array<T>	concat(T... items) Combines two or more arrays.
Boolean	every(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn) Determines whether all the members of an array satisfy the specified test.
Boolean	every(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn, Object thisArg) Determines whether all the members of an array satisfy the specified test.
Array<T>	filter(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn) Returns the elements of an array that meet the condition specified in a callback function.
Array<T>	filter(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn, Object thisArg) Returns the elements of an array that meet the condition specified in a callback function.
void	forEach(Function.A3<? super T,? super Number,? super Array<T>,? extends Void> callbackfn) Performs the specified action for each element in an array.
void	forEach(Function.A3<? super T,? super Number,? super Array<T>,? extends Void> callbackfn, Object thisArg) Performs the specified action for each element in an array.
double	indexOf(T searchElement) Returns the index of the first occurrence of a value in an array.
double	indexOf(T searchElement, double fromIndex) Returns the index of the first occurrence of a value in an array.
static Boolean	isArray(Object arg)
Iterator<T>	iterator()
String	join() Adds all the elements of an array separated by the specified separator string.
String	join(String separator) Adds all the elements of an array separated by the specified separator string.
double	lastIndexOf(T searchElement) Returns the index of the last occurrence of a specified value in an array.
double	lastIndexOf(T searchElement, double fromIndex) Returns the index of the last occurrence of a specified value in an array.
int	length() Returns length of the array.
<U> Array<U>	map(Function.A3<? super T,? super Number,? super Array<T>,? extends U> callbackfn) Calls a defined callback function on each element of an array, and returns an array that contains the results.
<U> Array<U>	map(Function.A3<? super T,? super Number,? super Array<T>,? extends U> callbackfn, Object thisArg) Calls a defined callback function on each element of an array, and returns an array that contains the results.
static <T> Array<T>	newArray()
static <T> Array<T>	newArray(double arrayLength)
static <T> Array<T>	newArray(T... items)
T	pop() Removes the last element from an array and returns it.
double	push(T... items) Appends new elements to an array, and returns the new length of the array.
<U> U	reduce(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn) Calls the specified callback function for all the elements in an array.
<U> U	reduce(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn, U initialValue) Calls the specified callback function for all the elements in an array.
<U> U	reduceRight(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn) Calls the specified callback function for all the elements in an array, in descending order.
<U> U	reduceRight(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn, U initialValue) Calls the specified callback function for all the elements in an array, in descending order.
Array<T>	reverse() Reverses the elements in an Array.
T	shift() Removes the first element from an array and returns it.
Array<T>	slice() Returns a section of an array.
Array<T>	slice(double start) Returns a section of an array.
Array<T>	slice(double start, double end) Returns a section of an array.
Boolean	some(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn) Determines whether the specified callback function returns true for any element of an array.
Boolean	some(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn, Object thisArg) Determines whether the specified callback function returns true for any element of an array.
Array<T>	sort() Sorts an array.
Array<T>	sort(Function.A2<? super T,? super T,? extends Number> compareFn) Sorts an array.
Array<T>	splice(double start) Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Array<T>	splice(double start, double deleteCount, T... items) Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Object[]	toArray() Converts the JavaScript array into Java array.
String	toLocaleString() Returns a date converted to a string using the current locale.
String	toString() Returns a string representation of an array.
double	unshift(T... items) Inserts new elements at the start of an array.

Methods inherited from class net.java.html.lib.Objs

$as, $cast, $delete, $get, $js, $set, create, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, newObject, newObject, preventExtensions, propertyIsEnumerable, seal, valueOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

length

public Objs.Property<Number> length

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

prototype

public static Array<Object> prototype

Constructor Detail

Array

protected Array(Objs.Constructor<?> constructor,
                Object js)

Array

public Array(double arrayLength)

Array

public Array()

Array

public Array(T... items)

Method Detail

$as

public static Array<?> $as(Object obj)

Casts given object to this class.

Parameters:

obj - any object

Returns:

a view of the provided obj object

length

public int length()

Returns length of the array.

Returns:

value of length property converted to integer

$get

public T $get(double index)

Gets an item from the array.

Parameters:

index - the (integer) index to the array

Returns:

value at the index location

$set

public Array<T> $set(double index,
                     Object value)

Sets a value at index in the array.

Parameters:

index - the (integer) index into the array

value - value to assign at that index

Returns:

instance of this array

concat

public Array<T> concat(T... items)

Combines two or more arrays.

Parameters:

items - Additional items to add to the end of array1.

every

public Boolean every(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn,
                     Object thisArg)

Determines whether all the members of an array satisfy the specified test.

Parameters:

callbackfn - A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

every

public Boolean every(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn)

Determines whether all the members of an array satisfy the specified test.

Parameters:

callbackfn - A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

filter

public Array<T> filter(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn,
                       Object thisArg)

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

callbackfn - A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

filter

public Array<T> filter(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn)

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

callbackfn - A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

forEach

public void forEach(Function.A3<? super T,? super Number,? super Array<T>,? extends Void> callbackfn,
                    Object thisArg)

Performs the specified action for each element in an array.

Parameters:

callbackfn - A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

forEach

public void forEach(Function.A3<? super T,? super Number,? super Array<T>,? extends Void> callbackfn)

Performs the specified action for each element in an array.

Parameters:

callbackfn - A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

indexOf

public double indexOf(T searchElement,
                      double fromIndex)

Returns the index of the first occurrence of a value in an array.

Parameters:

searchElement - The value to locate in the array.

fromIndex - The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

indexOf

public double indexOf(T searchElement)

Returns the index of the first occurrence of a value in an array.

Parameters:

searchElement - The value to locate in the array.

fromIndex - The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

join

public String join(String separator)

Adds all the elements of an array separated by the specified separator string.

Parameters:

separator - A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

join

public String join()

Adds all the elements of an array separated by the specified separator string.

Parameters:

separator - A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

lastIndexOf

public double lastIndexOf(T searchElement,
                          double fromIndex)

Returns the index of the last occurrence of a specified value in an array.

Parameters:

searchElement - The value to locate in the array.

fromIndex - The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

lastIndexOf

public double lastIndexOf(T searchElement)

Returns the index of the last occurrence of a specified value in an array.

Parameters:

searchElement - The value to locate in the array.

fromIndex - The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

map

public <U> Array<U> map(Function.A3<? super T,? super Number,? super Array<T>,? extends U> callbackfn,
                        Object thisArg)

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

callbackfn - A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

map

public <U> Array<U> map(Function.A3<? super T,? super Number,? super Array<T>,? extends U> callbackfn)

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

callbackfn - A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

pop

public T pop()

Removes the last element from an array and returns it.

push

public double push(T... items)

Appends new elements to an array, and returns the new length of the array.

Parameters:

items - New elements of the Array.

reduce

public <U> U reduce(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn,
                    U initialValue)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

callbackfn - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue - If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

reduce

public <U> U reduce(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

callbackfn - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue - If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

reduceRight

public <U> U reduceRight(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn,
                         U initialValue)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

callbackfn - A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue - If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

reduceRight

public <U> U reduceRight(Function.A4<? super U,? super T,? super Number,? super Array<T>,? extends U> callbackfn)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

callbackfn - A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue - If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

reverse

public Array<T> reverse()

Reverses the elements in an Array.

shift

public T shift()

Removes the first element from an array and returns it.

slice

public Array<T> slice(double start,
                      double end)

Returns a section of an array.

Parameters:

start - The beginning of the specified portion of the array.

end - The end of the specified portion of the array.

slice

public Array<T> slice()

Returns a section of an array.

Parameters:

start - The beginning of the specified portion of the array.

end - The end of the specified portion of the array.

slice

public Array<T> slice(double start)

Returns a section of an array.

Parameters:

start - The beginning of the specified portion of the array.

end - The end of the specified portion of the array.

some

public Boolean some(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn,
                    Object thisArg)

Determines whether the specified callback function returns true for any element of an array.

Parameters:

callbackfn - A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

some

public Boolean some(Function.A3<? super T,? super Number,? super Array<T>,? extends Boolean> callbackfn)

Determines whether the specified callback function returns true for any element of an array.

Parameters:

callbackfn - A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

sort

public Array<T> sort(Function.A2<? super T,? super T,? extends Number> compareFn)

Sorts an array.

Parameters:

compareFn - The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

sort

public Array<T> sort()

Sorts an array.

Parameters:

compareFn - The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

splice

public Array<T> splice(double start)

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

start - The zero-based location in the array from which to start removing elements.

splice

public Array<T> splice(double start,
                       double deleteCount,
                       T... items)

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

start - The zero-based location in the array from which to start removing elements.

deleteCount - The number of elements to remove.

items - Elements to insert into the array in place of the deleted elements.

toLocaleString

public String toLocaleString()

Description copied from class: Objs

Returns a date converted to a string using the current locale.

Overrides:

toLocaleString in class Objs

unshift

public double unshift(T... items)

Inserts new elements at the start of an array.

Parameters:

items - Elements to insert at the start of the Array.

isArray

public static Boolean isArray(Object arg)

newArray

public static <T> Array<T> newArray(double arrayLength)

newArray

public static <T> Array<T> newArray()

newArray

public static <T> Array<T> newArray(T... items)

toString

public String toString()

Returns a string representation of an array.

Overrides:

toString in class Objs

toArray

public Object[] toArray()

Converts the JavaScript array into Java array.

Returns:

elements in the Object[] array

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>