org.pepstock.charba.client.commons

Class ArrayObject

java.lang.Object

org.pepstock.charba.client.commons.Array

org.pepstock.charba.client.commons.ArrayObject

@JsType(isNative=true,
        name="Array",
        namespace="<global>")
public final class ArrayObject
extends Array

Array object which maps the java script object.
A simple wrapper around a homogeneous native array of object (extension of java script objects) values.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
static <E extends NativeObjectContainer> ArrayObject	fromOrEmpty(E item) Creates a java script array of objects starting from a native object containers and the array will have ONE 1 element.
static <E extends NativeObjectContainer> ArrayObject	fromOrEmpty(E[] items) Creates a java script array of objects starting from an array of native object containers.
static <E extends NativeObjectContainer> ArrayObject	fromOrEmpty(List<E> items) Creates a java script array of objects starting from a list of native object containers.
static <E extends NativeObjectContainer> ArrayObject	fromOrNull(E item) Creates a java script array of objects starting from a native object containers and the array will have ONE 1 element.
static <E extends NativeObjectContainer> ArrayObject	fromOrNull(E[] items) Creates a java script array of objects starting from an array of native object containers.
static <E extends NativeObjectContainer> ArrayObject	fromOrNull(List<E> items) Creates a java script array of objects starting from a list of native object containers.
NativeObject	get(int index) Gets the value at a given index.

Methods inherited from class org.pepstock.charba.client.commons.Array

isArray, isEmpty, length

Methods inherited from class java.lang.Object

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

Method Detail

fromOrNull

@JsOverlay
public static <E extends NativeObjectContainer> ArrayObject fromOrNull(E item)

Creates a java script array of objects starting from a native object containers and the array will have ONE 1 element.

Type Parameters:

E - type of native object containers

Parameters:

item - list of objects to load into new java script array.

Returns:

new array instance of ONE 1 element or null if argument is null

fromOrEmpty

@JsOverlay
public static <E extends NativeObjectContainer> ArrayObject fromOrEmpty(E item)

Creates a java script array of objects starting from a native object containers and the array will have ONE 1 element.

Type Parameters:

E - type of native object containers

Parameters:

item - list of objects to load into new java script array.

Returns:

new array instance of ONE 1 element or an empty array if argument is null

fromOrNull

@JsOverlay
public static <E extends NativeObjectContainer> ArrayObject fromOrNull(E[] items)

Creates a java script array of objects starting from an array of native object containers.

Type Parameters:

E - type of native object containers

Parameters:

items - list of objects to load into new java script array.

Returns:

new array instance of objects or null if argument is null or length to 0

fromOrEmpty

@JsOverlay
public static <E extends NativeObjectContainer> ArrayObject fromOrEmpty(E[] items)

Creates a java script array of objects starting from an array of native object containers.

Type Parameters:

E - type of native object containers

Parameters:

items - list of objects to load into new java script array.

Returns:

new array instance of objects or an empty array if argument is null or length to 0

fromOrNull

@JsOverlay
public static <E extends NativeObjectContainer> ArrayObject fromOrNull(List<E> items)

Creates a java script array of objects starting from a list of native object containers.

Type Parameters:

E - type of native object containers

Parameters:

items - list of objects to load into new java script array.

Returns:

new array instance of objects or null if the argument is null or empty

fromOrEmpty

@JsOverlay
public static <E extends NativeObjectContainer> ArrayObject fromOrEmpty(List<E> items)

Creates a java script array of objects starting from a list of native object containers.

Type Parameters:

E - type of native object containers

Parameters:

items - list of objects to load into new java script array.

Returns:

new array instance of objects or an empty array if argument is null or empty

get

@JsOverlay
public NativeObject get(int index)

Gets the value at a given index. If no value exists at the given index, a type-conversion error will occur in Development Mode and unpredictable behavior may occur in Production Mode. If the numeric value returned is non-integral, it will cause a warning in Development Mode, and may affect the results of mathematical expressions.

Parameters:

index - the index to be retrieved

Returns:

the value at the given index