org.liquidplayer.javascript

Class JSArray<T>

java.lang.Object

org.liquidplayer.javascript.JSValue

org.liquidplayer.javascript.JSObject

org.liquidplayer.javascript.JSFunction

org.liquidplayer.javascript.JSBaseArray<T>

org.liquidplayer.javascript.JSArray<T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

Direct Known Subclasses:

JSRegExp.ExecResult

public class JSArray<T>
extends JSBaseArray<T>

A convenience class for handling JavaScript arrays. Implements java.util.List interface for simple integration with Java methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JSArray.EachBooleanCallback<T> Interface containing a condition test callback function
class	JSArray.EntriesIterator<U> An array entry Iterator
static interface	JSArray.ForEachCallback<T> Interface containing a function to call on each element of an array
class	JSArray.KeysIterator An array key Iterator
static interface	JSArray.MapCallback<T> Interface containing a map function
static interface	JSArray.ReduceCallback Interface containing a reduce function
static interface	JSArray.SortCallback<T> Interface containing a compare function callback for sort

Nested classes/interfaces inherited from class org.liquidplayer.javascript.JSObject

JSObject.jsexport, JSObject.Property<T>

Field Summary

Fields inherited from class org.liquidplayer.javascript.JSObject

JSPropertyAttributeDontDelete, JSPropertyAttributeDontEnum, JSPropertyAttributeNone, JSPropertyAttributeReadOnly

Constructor Summary

Constructors

Constructor and Description
JSArray(JSContext ctx, java.lang.Class<T> cls) Creates an empty JavaScript array object
JSArray(JSContext ctx, java.util.Collection list, java.lang.Class<T> cls) Creates a JavaScript array object, initialized with 'list' Java values
JSArray(JSContext ctx, JSValue[] array, java.lang.Class<T> cls) Creates a JavaScript array object, initialized with 'array' JSValues
JSArray(JSContext ctx, java.lang.Object[] array, java.lang.Class<T> cls) Creates a JavaScript array object, initialized with 'array' Java values

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element)
JSArray<T>	concat(java.lang.Object... params) JavaScript Array.prototype.concat(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/concat
JSArray<T>	copyWithin(int target) JavaScript Array.prototype.copyWithin(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin
JSArray<T>	copyWithin(int target, int start) JavaScript Array.prototype.copyWithin(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin
JSArray<T>	copyWithin(int target, int start, int end) JavaScript Array.prototype.copyWithin(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin
JSArray.EntriesIterator<T>	entries() JavaScript Array.prototype.entries(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries
boolean	every(JSArray.EachBooleanCallback<T> callback) JavaScript: Array.prototype.every(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every
boolean	every(JSFunction callback) JavaScript: Array.prototype.every(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every
boolean	every(JSFunction callback, JSObject thiz) JavaScript: Array.prototype.every(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every
JSArray<T>	fill(T value) JavaScript Array.prototype.fill(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/fill
JSArray<T>	fill(T value, int start) JavaScript Array.prototype.fill(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/fill
JSArray<T>	fill(T value, int start, int end) JavaScript Array.prototype.fill(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/fill
JSArray<T>	filter(JSArray.EachBooleanCallback<T> callback)
JSArray<T>	filter(JSFunction callback) JavaScript Array.prototype.filter(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter
JSArray<T>	filter(JSFunction callback, JSObject thiz) JavaScript Array.prototype.filter(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter
T	find(JSArray.EachBooleanCallback<T> callback) JavaScript Array.prototype.find(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find
T	find(JSFunction callback) JavaScript Array.prototype.find(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find
T	find(JSFunction callback, JSObject thiz) JavaScript Array.prototype.find(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find
int	findIndex(JSArray.EachBooleanCallback<T> callback) JavaScript Array.prototype.findIndex(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex
int	findIndex(JSFunction callback) JavaScript Array.prototype.findIndex(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex
int	findIndex(JSFunction callback, JSObject thiz) JavaScript Array.prototype.findIndex(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex
void	forEach(JSArray.ForEachCallback<T> callback) JavaScript Array.prototype.forEach(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach
void	forEach(JSFunction callback) JavaScript Array.prototype.forEach(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach
void	forEach(JSFunction callback, JSObject thiz) JavaScript Array.prototype.forEach(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach
static JSArray<JSValue>	from(JSContext ctx, java.lang.Object arrayLike) JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from
static JSArray<JSValue>	from(JSContext ctx, java.lang.Object arrayLike, JSArray.MapCallback<JSValue> mapFn) JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from
static JSArray<JSValue>	from(JSContext ctx, java.lang.Object arrayLike, JSFunction mapFn) JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from
static JSArray<JSValue>	from(JSContext ctx, java.lang.Object arrayLike, JSFunction mapFn, JSObject thiz) JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from
boolean	includes(T element) JavaScript Array.prototype.includes(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes
boolean	includes(T element, int fromIndex) JavaScript Array.prototype.includes(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes
int	indexOf(T element, int fromIndex) JavaScript Array.prototype.indexOf(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf
static boolean	isArray(JSValue value) JavaScript Array.isArray(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
java.lang.String	join() JavaScript Array.prototype.join(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join
java.lang.String	join(java.lang.String separator) JavaScript Array.prototype.join(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join
JSArray.KeysIterator	keys() JavaScript Array.prototype.keys(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/keys
int	lastIndexOf(T element, int fromIndex) JavaScript Array.prototype.lastIndexOf(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf
JSArray<JSValue>	map(JSArray.MapCallback<T> callback) JavaScript Array.prototype.map(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map
JSArray<JSValue>	map(JSFunction callback) JavaScript Array.prototype.map(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map
JSArray<JSValue>	map(JSFunction callback, JSObject thiz) JavaScript Array.prototype.map(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map
static JSArray<JSValue>	of(JSContext ctx, java.lang.Object... params) JavaScript Array.of(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/of
T	pop() JavaScript Array.prototype.pop(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/pop
int	push(T... elements) JavaScript Array.prototype.push(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/push
JSValue	reduce(JSArray.ReduceCallback callback) JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce
JSValue	reduce(JSArray.ReduceCallback callback, java.lang.Object initialValue) JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce
JSValue	reduce(JSFunction callback) JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce
JSValue	reduce(JSFunction callback, java.lang.Object initialValue) JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce
JSValue	reduceRight(JSArray.ReduceCallback callback) JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight
JSValue	reduceRight(JSArray.ReduceCallback callback, java.lang.Object initialValue) JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight
JSValue	reduceRight(JSFunction callback) JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight
JSValue	reduceRight(JSFunction callback, java.lang.Object initialValue) JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight
T	remove(int index)
JSArray<T>	reverse() JavaScript Array.prototype.reverse(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reverse
T	shift() JavaScript Array.prototype.shift(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/shift
JSArray<T>	slice() JavaScript Array.prototype.slice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice
JSArray<T>	slice(int begin) JavaScript Array.prototype.slice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice
JSArray<T>	slice(int begin, int end) JavaScript Array.prototype.slice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice
boolean	some(JSArray.EachBooleanCallback<T> callback) JavaScript: Array.prototype.some(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some
boolean	some(JSFunction callback) JavaScript: Array.prototype.some(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some
boolean	some(JSFunction callback, JSObject thiz) JavaScript: Array.prototype.some(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some
JSArray<T>	sort() JavaScript Array.prototype.sort(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
JSArray<T>	sort(JSArray.SortCallback<T> callback) JavaScript Array.prototype.sort(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
JSArray<T>	sort(JSFunction compare) JavaScript Array.prototype.sort(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
JSArray<T>	splice(int start, int deleteCount, T... elements) JavaScript Array.prototype.splice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice
java.util.List<T>	subList(int fromIndex, int toIndex)
java.lang.String	toLocaleString() JavaScript Array.prototype.toLocaleString(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/toLocaleString Note: AndroidJSCore does not include the localization library by default, as it adds too much data to the build.
int	unshift(T... elements) JavaScript Array.prototype.unshift(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/unshift

Methods inherited from class org.liquidplayer.javascript.JSBaseArray

add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, retainAll, set, size, toArray, toArray, toArray

Methods inherited from class org.liquidplayer.javascript.JSFunction

apply, call, call, newInstance

Methods inherited from class org.liquidplayer.javascript.JSObject

__nullFunc, deleteProperty, getThis, hasProperty, isConstructor, isFunction, property, property, property, propertyAtIndex, propertyAtIndex, propertyNames, prototype, prototype

Methods inherited from class org.liquidplayer.javascript.JSValue

getContext, isArray, isBoolean, isDate, isEqual, isFloat32Array, isFloat64Array, isInstanceOfConstructor, isInt16Array, isInt32Array, isInt8Array, isNull, isNumber, isObject, isStrictEqual, isString, isTypedArray, isUint16Array, isUint32Array, isUint8Array, isUint8ClampedArray, isUndefined, toBoolean, toFunction, toJSArray, toJSON, toNumber, toObject, toString, valueHash, valueRef

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

JSArray

public JSArray(JSContext ctx,
               JSValue[] array,
               java.lang.Class<T> cls)

Creates a JavaScript array object, initialized with 'array' JSValues

Parameters:

ctx - The JSContext to create the array in

array - An array of JSValues with which to initialize the JavaScript array object

cls - The class of the component objects

Since:

0.1.0

JSArray

public JSArray(JSContext ctx,
               java.lang.Class<T> cls)

Creates an empty JavaScript array object

Parameters:

ctx - The JSContext to create the array in

cls - The class of the component objects

Since:

0.1.0

JSArray

public JSArray(JSContext ctx,
               java.lang.Object[] array,
               java.lang.Class<T> cls)

Creates a JavaScript array object, initialized with 'array' Java values

Parameters:

ctx - The JSContext to create the array in

array - An array of Java objects with which to initialize the JavaScript array object. Each Object will be converted to a JSValue

cls - The class of the component objects

Since:

0.1.0

JSArray

public JSArray(JSContext ctx,
               java.util.Collection list,
               java.lang.Class<T> cls)

Creates a JavaScript array object, initialized with 'list' Java values

Parameters:

ctx - The JSContext to create the array in

list - The Collection of values with which to initialize the JavaScript array object. Each object will be converted to a JSValue

cls - The class of the component objects

Since:

0.1.0

Method Detail

add

public void add(int index,
                T element)

Specified by:

add in interface java.util.List<T>

Overrides:

add in class JSBaseArray<T>

Since:

0.1.0

See Also:

List.add(int, Object)

remove

public T remove(int index)

Specified by:

remove in interface java.util.List<T>

Overrides:

remove in class JSBaseArray<T>

Since:

0.1.0

See Also:

List.remove(int)

subList

@NonNull
public java.util.List<T> subList(int fromIndex,
                                          int toIndex)

Since:

0.1.0

See Also:

List.subList(int, int)

from

public static JSArray<JSValue> from(JSContext ctx,
                                    java.lang.Object arrayLike,
                                    JSFunction mapFn,
                                    JSObject thiz)

JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from

Parameters:

ctx - the JavaScript context in which to create the array

arrayLike - Any array-like object to build the array from

mapFn - A JavaScript function to map each new element of the array

thiz - The 'this' pointer passed to 'mapFn'

Returns:

A new JavaScript array

Since:

0.1.0

from

public static JSArray<JSValue> from(JSContext ctx,
                                    java.lang.Object arrayLike,
                                    JSFunction mapFn)

JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from

Parameters:

ctx - the JavaScript context in which to create the array

arrayLike - Any array-like object to build the array from

mapFn - A JavaScript function to map each new element of the array

Returns:

A new JavaScript array

Since:

0.1.0

from

public static JSArray<JSValue> from(JSContext ctx,
                                    java.lang.Object arrayLike)

JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from

Parameters:

ctx - the JavaScript context in which to create the array

arrayLike - Any array-like object to build the array from

Returns:

A new JavaScript array

Since:

0.1.0

from

public static JSArray<JSValue> from(JSContext ctx,
                                    java.lang.Object arrayLike,
                                    JSArray.MapCallback<JSValue> mapFn)

JavaScript Array.from(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from

Parameters:

ctx - the JavaScript context in which to create the array

arrayLike - Any array-like object to build the array from

mapFn - A Java function to map each new element of the array

Returns:

A new JavaScript array

Since:

0.1.0

isArray

public static boolean isArray(JSValue value)

JavaScript Array.isArray(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray

Parameters:

value - the value to test

Returns:

true if 'value' is an array, false otherwise

Since:

0.1.0

of

public static JSArray<JSValue> of(JSContext ctx,
                                  java.lang.Object... params)

JavaScript Array.of(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/of

Parameters:

ctx - The JSContext in which to create the array

params - Elements to add to the array

Returns:

the new JavaScript array

Since:

0.1.0

concat

public JSArray<T> concat(java.lang.Object... params)

JavaScript Array.prototype.concat(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/concat

Parameters:

params - values to concantenate to the array

Returns:

a new JSArray

Since:

0.1.0

pop

public T pop()

JavaScript Array.prototype.pop(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/pop

Returns:

the popped element

Since:

0.1.0

push

public int push(T... elements)

JavaScript Array.prototype.push(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/push

Parameters:

elements - The elements to push on the array

Returns:

new size of the mutated array

Since:

0.1.0

shift

public T shift()

JavaScript Array.prototype.shift(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/shift

Returns:

the element shifted off the front of the array

Since:

0.1.0

splice

public JSArray<T> splice(int start,
                         int deleteCount,
                         T... elements)

JavaScript Array.prototype.splice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice

Parameters:

start - the index to start splicing from (inclusive)

deleteCount - the number of elements to remove

elements - the elements to insert into the array at index 'start'

Returns:

a new array containing the removed elements

Since:

0.1.0

toLocaleString

public java.lang.String toLocaleString()

JavaScript Array.prototype.toLocaleString(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/toLocaleString Note: AndroidJSCore does not include the localization library by default, as it adds too much data to the build. This function is supported for completeness, but localized values will show as empty strings

Returns:

a localized string representation of the array

unshift

public int unshift(T... elements)

JavaScript Array.prototype.unshift(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/unshift

Parameters:

elements - The values to add to the front of the array

Returns:

the new size of the mutated array

Since:

0.1.0

entries

public JSArray.EntriesIterator<T> entries()

JavaScript Array.prototype.entries(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries

Returns:

an entry iterator

Since:

0.1.0

every

public boolean every(JSFunction callback,
                     JSObject thiz)

JavaScript: Array.prototype.every(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every

Parameters:

callback - the JavaScript function to call on each element

thiz - the 'this' value passed to callback

Returns:

true if every element in the array meets the condition, false otherwise

Since:

0.1.0

every

public boolean every(JSFunction callback)

JavaScript: Array.prototype.every(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every

Parameters:

callback - the JavaScript function to call on each element

Returns:

true if every element in the array meets the condition, false otherwise

Since:

0.1.0

every

public boolean every(JSArray.EachBooleanCallback<T> callback)

JavaScript: Array.prototype.every(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every

Parameters:

callback - the Java function to call on each element

Returns:

true if every element in the array meets the condition, false otherwise

Since:

0.1.0

find

public T find(JSFunction callback,
              JSObject thiz)

JavaScript Array.prototype.find(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find

Parameters:

callback - the JavaScript function to call on each element

thiz - the 'this' value passed to callback

Returns:

the first value matching the condition set by the function

Since:

0.1.0

find

public T find(JSFunction callback)

JavaScript Array.prototype.find(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find

Parameters:

callback - the JavaScript function to call on each element

Returns:

the first value matching the condition set by the function

Since:

0.1.0

find

public T find(JSArray.EachBooleanCallback<T> callback)

JavaScript Array.prototype.find(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find

Parameters:

callback - the Java function to call on each element

Returns:

the first value matching the condition set by the function

Since:

0.1.0

findIndex

public int findIndex(JSFunction callback,
                     JSObject thiz)

JavaScript Array.prototype.findIndex(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex

Parameters:

callback - the JavaScript function to call on each element

thiz - the 'this' value passed to callback

Returns:

the index of the first value matching the condition set by the function

Since:

0.1.0

findIndex

public int findIndex(JSFunction callback)

JavaScript Array.prototype.findIndex(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex

Parameters:

callback - the JavaScript function to call on each element

Returns:

the index of the first value matching the condition set by the function

Since:

0.1.0

findIndex

public int findIndex(JSArray.EachBooleanCallback<T> callback)

JavaScript Array.prototype.findIndex(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex

Parameters:

callback - the Java function to call on each element

Returns:

the index of the first value matching the condition set by the function

Since:

0.1.0

forEach

public void forEach(JSFunction callback,
                    JSObject thiz)

JavaScript Array.prototype.forEach(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach

Parameters:

callback - the JavaScript function to call on each element

thiz - the 'this' value passed to callback

Since:

0.1.0

forEach

public void forEach(JSFunction callback)

JavaScript Array.prototype.forEach(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach

Parameters:

callback - the JavaScript function to call on each element

Since:

0.1.0

forEach

public void forEach(JSArray.ForEachCallback<T> callback)

JavaScript Array.prototype.forEach(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach

Parameters:

callback - the Java function to call on each element

Since:

0.1.0

includes

public boolean includes(T element,
                        int fromIndex)

JavaScript Array.prototype.includes(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes

Parameters:

element - the value to search for

fromIndex - the index in the array to start searching from

Returns:

true if the element exists in the array, false otherwise

Since:

0.1.0

includes

public boolean includes(T element)

JavaScript Array.prototype.includes(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes

Parameters:

element - the value to search for

Returns:

true if the element exists in the array, false otherwise

Since:

0.1.0

indexOf

public int indexOf(T element,
                   int fromIndex)

JavaScript Array.prototype.indexOf(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf

Parameters:

element - the value to search for

fromIndex - the index in the array to start searching from

Returns:

index of the first instance of 'element', -1 if not found

Since:

0.1.0

join

public java.lang.String join(java.lang.String separator)

JavaScript Array.prototype.join(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join

Parameters:

separator - the separator to use between values

Returns:

a string representation of the joined array

Since:

0.1.0

join

public java.lang.String join()

JavaScript Array.prototype.join(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join

Returns:

a string representation of the joined array with a comma separator

Since:

0.1.0

keys

public JSArray.KeysIterator keys()

JavaScript Array.prototype.keys(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/keys

Returns:

An array index iterator

Since:

0.1.0

lastIndexOf

public int lastIndexOf(T element,
                       int fromIndex)

JavaScript Array.prototype.lastIndexOf(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf

Parameters:

element - the value to search for

fromIndex - the index in the array to start searching from (reverse order)

Returns:

index of the last instance of 'element', -1 if not found

Since:

0.1.0

reduce

public JSValue reduce(JSFunction callback,
                      java.lang.Object initialValue)

JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce

Parameters:

callback - The JavaScript reduce function to call

initialValue - The initial value of the reduction

Returns:

A reduction of the mapped array

Since:

0.1.0

reduce

public JSValue reduce(JSFunction callback)

JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce

Parameters:

callback - The JavaScript reduce function to call

Returns:

A reduction of the mapped array

Since:

0.1.0

reduce

public JSValue reduce(JSArray.ReduceCallback callback,
                      java.lang.Object initialValue)

JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce

Parameters:

callback - The Java reduce function to call

initialValue - The initial value of the reduction

Returns:

A reduction of the mapped array

Since:

0.1.0

reduce

public JSValue reduce(JSArray.ReduceCallback callback)

JavaScript Array.prototype.reduce(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce

Parameters:

callback - The Java reduce function to call

Returns:

A reduction of the mapped array

Since:

0.1.0

reduceRight

public JSValue reduceRight(JSFunction callback,
                           java.lang.Object initialValue)

JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight

Parameters:

callback - The JavaScript reduce function to call

initialValue - The initial value of the reduction

Returns:

A reduction of the mapped array

Since:

0.1.0

reduceRight

public JSValue reduceRight(JSFunction callback)

JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight

Parameters:

callback - The JavaScript reduce function to call

Returns:

A reduction of the mapped array

Since:

0.1.0

reduceRight

public JSValue reduceRight(JSArray.ReduceCallback callback,
                           java.lang.Object initialValue)

JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight

Parameters:

callback - The Java reduce function to call

initialValue - The initial value of the reduction

Returns:

A reduction of the mapped array

Since:

0.1.0

reduceRight

public JSValue reduceRight(JSArray.ReduceCallback callback)

JavaScript Array.prototype.reduceRight(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight

Parameters:

callback - The Java reduce function to call

Returns:

A reduction of the mapped array

Since:

0.1.0

some

public boolean some(JSFunction callback,
                    JSObject thiz)

JavaScript: Array.prototype.some(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some

Parameters:

callback - the JavaScript function to call on each element

thiz - the 'this' value passed to callback

Returns:

true if some element in the array meets the condition, false otherwise

Since:

0.1.0

some

public boolean some(JSFunction callback)

JavaScript: Array.prototype.some(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some

Parameters:

callback - the JavaScript function to call on each element

Returns:

true if some element in the array meets the condition, false otherwise

Since:

0.1.0

some

public boolean some(JSArray.EachBooleanCallback<T> callback)

JavaScript: Array.prototype.some(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some

Parameters:

callback - the Java function to call on each element

Returns:

true if some element in the array meets the condition, false otherwise

Since:

0.1.0

copyWithin

public JSArray<T> copyWithin(int target,
                             int start,
                             int end)

JavaScript Array.prototype.copyWithin(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin

Parameters:

target - index to copy sequence to

start - index from which to start copying from

end - index from which to end copying from

Returns:

this (mutable operation)

Since:

0.1.0

copyWithin

public JSArray<T> copyWithin(int target,
                             int start)

JavaScript Array.prototype.copyWithin(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin

Parameters:

target - index to copy sequence to

start - index from which to start copying from

Returns:

this (mutable operation)

Since:

0.1.0

copyWithin

public JSArray<T> copyWithin(int target)

JavaScript Array.prototype.copyWithin(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin

Parameters:

target - index to copy sequence to

Returns:

this (mutable operation)

Since:

0.1.0

fill

public JSArray<T> fill(T value,
                       int start,
                       int end)

JavaScript Array.prototype.fill(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/fill

Parameters:

value - the value to fill

start - the index to start filling

end - the index (exclusive) to stop filling

Returns:

this (mutable)

Since:

0.1.0

fill

public JSArray<T> fill(T value,
                       int start)

JavaScript Array.prototype.fill(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/fill

Parameters:

value - the value to fill

start - the index to start filling

Returns:

this (mutable)

Since:

0.1.0

fill

public JSArray<T> fill(T value)

JavaScript Array.prototype.fill(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/fill

Parameters:

value - the value to fill

Returns:

this (mutable)

Since:

0.1.0

filter

public JSArray<T> filter(JSFunction callback,
                         JSObject thiz)

JavaScript Array.prototype.filter(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter

Parameters:

callback - the JavaScript function to call on each element

thiz - the 'this' value passed to callback

Returns:

a new filtered array

Since:

0.1.0

filter

public JSArray<T> filter(JSFunction callback)

JavaScript Array.prototype.filter(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter

Parameters:

callback - the JavaScript function to call on each element

Returns:

a new filtered array

Since:

0.1.0

filter

public JSArray<T> filter(JSArray.EachBooleanCallback<T> callback)

map

public JSArray<JSValue> map(JSFunction callback,
                            JSObject thiz)

JavaScript Array.prototype.map(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map

Parameters:

callback - the JavaScript function to call on each element

thiz - the 'this' value passed to callback

Returns:

a new mapped array

Since:

0.1.0

map

public JSArray<JSValue> map(JSFunction callback)

JavaScript Array.prototype.map(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map

Parameters:

callback - the JavaScript function to call on each element

Returns:

a new mapped array

Since:

0.1.0

map

public JSArray<JSValue> map(JSArray.MapCallback<T> callback)

JavaScript Array.prototype.map(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map

Parameters:

callback - the Java function to call on each element

Returns:

a new mapped array

Since:

0.1.0

reverse

public JSArray<T> reverse()

JavaScript Array.prototype.reverse(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reverse

Returns:

this (mutable)

Since:

0.1.0

slice

public JSArray<T> slice(int begin,
                        int end)

JavaScript Array.prototype.slice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice

Parameters:

begin - the index to begin slicing (inclusive)

end - the index to end slicing (exclusive)

Returns:

the new sliced array

Since:

0.1.0

slice

public JSArray<T> slice(int begin)

JavaScript Array.prototype.slice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice

Parameters:

begin - the index to begin slicing (inclusive)

Returns:

the new sliced array

Since:

0.1.0

slice

public JSArray<T> slice()

JavaScript Array.prototype.slice(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice

Returns:

the new sliced array (essentially a copy of the original array)

Since:

0.1.0

sort

public JSArray<T> sort(JSFunction compare)

JavaScript Array.prototype.sort(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort

Parameters:

compare - the JavaScript compare function to use for sorting

Returns:

this (mutable)

Since:

0.1.0

sort

public JSArray<T> sort(JSArray.SortCallback<T> callback)

JavaScript Array.prototype.sort(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort

Parameters:

callback - the Java compare function to use for sorting

Returns:

this (mutable)

Since:

0.1.0

sort

public JSArray<T> sort()

JavaScript Array.prototype.sort(), see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort

Returns:

this (mutable)

Since:

0.1.0