UniversalContainer (js4j 0.1.0 API)

java.lang.Object
- com.github.jshaptic.js4j.UniversalContainer

All Implemented Interfaces:: Iterable<UniversalContainer>

public class UniversalContainer
extends Object
implements Iterable<UniversalContainer>

Wrapper container for various types of objects, also provides some generic methods for manipulation over stored object regardless of the class. Simply, UniversalContainer just emulates behaviour of javascript variables and its methods. All methods are implemented as close as possible to JS API. It was created to ease porting of Javascript code to Java, but can be used in any other cases.

All public methods in this class try to replicate behaviour of JS variables as much as possible, however there can be some differences, but API is quite close to JS. Full list of all implemented javascript methods and properties (fully, partially or differently):

Object.create()
Object.keys()

Object.prototype.constructor
Object.prototype.toString()
Object.prototype.valueOf()

String.prototype.length
String.prototype.concat()
String.prototype.indexOf()

Array.isArray()

Array.prototype.length
Array.prototype.pop()
Array.prototype.push()
Array.prototype.shift()
Array.prototype.splice()
Array.prototype.concat()
Array.prototype.indexOf()

Also this class has shortcuts to some popular methods from Lodash library, see Lodash class.

Table of all supported container types and corresponding java raw classes
Container	Java raw class
UNDEFINED	null (any class)
NULL
BOOLEAN LITERAL	boolean, `Boolean`
NUMBER LITERAL	int, float, double, `Integer`, `Float`, `Double`
STRING LITERAL	`String`
OTHER LITERAL	any other class except listed in this table
OBJECT	`Map` (and any other class inherited from it)
ARRAY	Java arrays, `List` (and any other class inherited from it), `Set` (and any other class inherited from it)

Constructor Summary

Constructors
Constructor and Description
`UniversalContainer(Iterable<Object> list)` Constructor, which will produce ARRAY container with the values based on the specified Iterable object.
`UniversalContainer(Map<Object,Object> map)` Constructor, which will produce OBJECT container with the values based on the specified Map.
`UniversalContainer(Object value)` Constructor, which will produce simple LITERAL container with the specified value.
`UniversalContainer(Object[] array)` Constructor, which will produce ARRAY container with the values based on the specified array.
`UniversalContainer(UniversalContainer container)` Constructor, which will produce very shallow copy of the specified container.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`asBoolean()` Converts current value to a boolean value.
`boolean`	`asBoolean(int index)` Converts value, which is located in the specified position to a boolean value.
`boolean`	`asBoolean(String property)` Converts value, which is located in the specified property to a boolean value.
`double`	`asDouble()` Converts current value to a double value.
`double`	`asDouble(int index)` Converts value, which is located in the specified position to a double value.
`double`	`asDouble(String property)` Converts value, which is located in the specified property to a double value.
`int`	`asInt()` Converts current value to an integer value.
`int`	`asInt(int index)` Converts value, which is located in the specified position to an integer value.
`int`	`asInt(String property)` Converts value, which is located in the specified property to an integer value.
`<T> List<T>`	`asList(Class<T> clazz)` Converts current ARRAY container to List.
`<T> Map<String,T>`	`asMap(Class<T> clazz)` Converts current OBJECT container to Map.
`String`	`asString()` Converts current value to a string value.
`String`	`asString(int index)` Converts value, which is located in the specified position to a string value.
`String`	`asString(String property)` Converts value, which is located in the specified property to a string value.
`UniversalContainer`	`clone()` A shortcut to the `Lodash.clone(UniversalContainer)` method.
`UniversalContainer`	`concat(Object... sources)` This method has two different algorithms depending on the current container type:
`UniversalContainer`	`create()` Creates new OBJECT container, with the current container as a prototype.
`boolean`	`deepEquals(Object other)` A shortcut to the `Lodash.isEqual(UniversalContainer, Object)` method.
`void`	`delete(int index)` Removes an index from the current container.
`void`	`delete(String property)` Removes a property from the current container.
`boolean`	`equals(Object other)` Compares current container and passed value and returns true if they equal.
`UniversalContainer`	`extend(UniversalContainer... sources)` A shortcut to the `Lodash.extend(UniversalContainer, UniversalContainer...)` method.
`UniversalContainer`	`get(int index)` Reads a value from the current container located at specified index.
`UniversalContainer`	`get(String property)` Reads specified property from the current container.
`ContainerConstructor`	`getConstructor()` Reads built-in "constructor" property.
`Integer`	`getLength()` Reads built-in "length" property.
`Integer`	`getLength(Integer defaultLength)` Reads built-in "length" property.
`UniversalContainer`	`getProto()` Returns current container's prototype.
`boolean`	`has(int index)` Checks if specified index exists in the current container.
`boolean`	`has(int index, boolean own)` Checks if specified index exists in the current container.
`boolean`	`has(String property)` Checks if specified property exists in the current container.
`boolean`	`has(String property, boolean own)` Checks if specified property exists in the current container.
`int`	`indexOf(Object value)` This method has two different algorithms depending on the current container type:
`boolean`	`isArray()` Checks if current container is ARRAY container.
`boolean`	`isArray(int index)` Checks if value at specified position is ARRAY container.
`boolean`	`isArray(String property)` Checks if value in specified property is ARRAY container.
`boolean`	`isBoolean()` Checks if current container is BOOLEAN LITERAL container.
`boolean`	`isBoolean(int index)` Checks if value at specified position is BOOLEAN LITERAL container.
`boolean`	`isBoolean(String property)` Checks if value in specified property is BOOLEAN LITERAL container.
`boolean`	`isNull()` Checks if current container is NULL container.
`boolean`	`isNull(int index)` Checks if value at specified position is NULL container.
`boolean`	`isNull(String property)` Checks if value in specified property is NULL container.
`boolean`	`isNumber()` Checks if current container is NUMBER LITERAL container.
`boolean`	`isNumber(int index)` Checks if value at specified position is NUMBER LITERAL container.
`boolean`	`isNumber(String property)` Checks if value in specified property is NUMBER LITERAL container.
`boolean`	`isObject()` Checks if current container is OBJECT container.
`boolean`	`isObject(int index)` Checks if value at specified position is OBJECT, ARRAY or NULL container.
`boolean`	`isObject(String property)` Checks if value in specified property is OBJECT, ARRAY or NULL container.
`boolean`	`isString()` Checks if current container is STRING LITERAL container.
`boolean`	`isString(int index)` Checks if value at specified position is STRING LITERAL container.
`boolean`	`isString(String property)` Checks if value in specified property is STRING LITERAL container.
`boolean`	`isUndefined()` Checks if current container is UNDEFINED container.
`boolean`	`isUndefined(int index)` Checks if value at specified position is UNDEFINED container.
`boolean`	`isUndefined(String property)` Checks if value in specified property is UNDEFINED container.
`Iterator<UniversalContainer>`	`iterator()` Creates iterator over current container values (if it's ARRAY or STRING) or keys (if OBJECT), which can be in for statement.
`Set<String>`	`keys()` Returns a set of all own indexes/properties of the current container.
`Set<String>`	`keys(boolean own)` Returns a set of all indexes/properties of the current container.
`UniversalContainer`	`last()` A shortcut to the `Lodash.last(UniversalContainer)` method.
`UniversalContainer`	`merge(UniversalContainer... sources)` A shortcut to the `Lodash.merge(UniversalContainer, UniversalContainer...)` method.
`UniversalContainer`	`pop()` Removes the last value from the current container and returns removed value.
`int`	`push(Object... values)` Adds one or more values to the end of the current ARRAY container and returns new length.
`UniversalContainer`	`set(int index, Object value)` Writes value in the current container under specified index.
`UniversalContainer`	`set(String property, Object value)` Writes value in the current container under specified property.
`void`	`setLength(int newLength)` Overrides built-in "length" property.
`UniversalContainer`	`shift()` Removes the element at the zeroeth index and shifts the values at consecutive indexes down, then returns the removed value.
`UniversalContainer`	`splice(int start, int deleteCount)` Changes the content of th current ARRAY container by removing existing elements using start and deleteCount parameters.
`boolean`	`test()` Checks if current container can be resolved to true in "if" conditions.
`boolean`	`test(int index)` Checks if value at specified position can be resolved to true in "if" conditions.
`boolean`	`test(String property)` Checks if value in specified property can be resolved to true in "if" conditions.
`String`	`toString()` Returns a string representation of the current container.
`<T> T`	`valueOf()` Simply extracts value from the current container.
`<T> T`	`valueOf(int index)` Simply extracts value from the specified position in the current container.
`<T> T`	`valueOf(String property)` Simply extracts value from the specified property in the current container.
`UniversalContainer`	`values()` A shortcut to the `Lodash.values(UniversalContainer)` method.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - UniversalContainer
```
public UniversalContainer(Object value)
```
    Constructor, which will produce simple LITERAL container with the specified value.
    
    Parameters:
    
    value - value, which will be stored in the LITERAL container.
  - UniversalContainer
```
public UniversalContainer(UniversalContainer container)
```
    Constructor, which will produce very shallow copy of the specified container. All changes in the copied container will be reflected in the specified container and vice versa.
    
    Parameters:
    
    container - container, which will be copied.
  - UniversalContainer
```
public UniversalContainer(Object[] array)
```
    Constructor, which will produce ARRAY container with the values based on the specified array.
    
    Parameters:
    
    array - java array, which will be used as source for new ARRAY container.
  - UniversalContainer
```
public UniversalContainer(Iterable<Object> list)
```
    Constructor, which will produce ARRAY container with the values based on the specified Iterable object.
    
    Parameters:
    
    list - any Iterable object, which will be used as source for new ARRAY container.
  - UniversalContainer
```
public UniversalContainer(Map<Object,Object> map)
```
    Constructor, which will produce OBJECT container with the values based on the specified Map.
    
    Parameters:
    
    map - any Map object, which will be used as source for new OBJECT container.
- Method Detail
  - asBoolean
```
public boolean asBoolean()
```
    Converts current value to a boolean value. Number 1 and string "1" both are treated as true. ARRAY containers with one element will be treated as single value, which means that this single element will be converted instead of current container, conversino rules will be the same.
    
    Returns:
    
    true, if value is one of the following: true, 1, "1", [1], ["1"]; false otherwise.
  - asBoolean
```
public boolean asBoolean(int index)
```
    Converts value, which is located in the specified position to a boolean value. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).asBoolean();
    
    Parameters:
    
    index - position of value, which will be converted to boolean.
    
    Returns:
    
    true, if value is one of the following: true, 1, "1", [1], ["1"]; false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    asBoolean()
  - asBoolean
```
public boolean asBoolean(String property)
```
    Converts value, which is located in the specified property to a boolean value. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).asBoolean();
    
    Parameters:
    
    property - name of the property, which value will be converted to boolean.
    
    Returns:
    
    true, if value is one of the following: true, 1, "1", [1], ["1"]; false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    asBoolean()
  - asDouble
```
public double asDouble()
```
    Converts current value to a double value. Boolean values true and false will be converted to 1.0 and to 0.0 accordingly, strings which can be parsed will be converted as well, otherwise 0.0 will be returned. ARRAY containers with one element will be treated as single value, which means that this single element will be converted instead of current container, conversino rules will be the same.
    
    Returns:
    
    either a double value, which is currently stored; or will return 1.0 if there is a true boolean value; or will try to parse string value; in all negative cases it will return 0.0.
  - asDouble
```
public double asDouble(int index)
```
    Converts value, which is located in the specified position to a double value. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).asDouble();
    
    Parameters:
    
    index - position of value, which will be converted to double.
    
    Returns:
    
    either a double value, which is currently stored; or will return 1.0 if there is a true boolean value; or will try to parse string value; in all negative cases it will return 0.0.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    asDouble()
  - asDouble
```
public double asDouble(String property)
```
    Converts value, which is located in the specified property to a double value. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).asDouble();
    
    Parameters:
    
    property - name of the property, which value will be converted to double.
    
    Returns:
    
    either a double value, which is currently stored; or will return 1.0 if there is a true boolean value; or will try to parse string value; in all negative cases it will return 0.0.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    asDouble()
  - asInt
```
public int asInt()
```
    Converts current value to an integer value. Boolean values true and false will be converted to 1 and to 0 accordingly, strings which can be parsed will be converted as well, otherwise 0 will be returned. ARRAY containers with one element will be treated as single value, which means that this single element will be converted instead of current container, conversino rules will be the same.
    
    Returns:
    
    either an integer value, which is currently stored; or will return 1 if there is a true boolean value; or will try to parse string value; in all negative cases it will return 0.
  - asInt
```
public int asInt(int index)
```
    Converts value, which is located in the specified position to an integer value. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).asInt();
    
    Parameters:
    
    index - position of value, which will be converted to integer.
    
    Returns:
    
    either an integer value, which is currently stored; or will return 1 if there is a true boolean value; or will try to parse string value; in all negative cases it will return 0.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    asInt()
  - asInt
```
public int asInt(String property)
```
    Converts value, which is located in the specified property to an integer value. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).asInt();
    
    Parameters:
    
    property - name of the property, which value will be converted to integer.
    
    Returns:
    
    either an integer value, which is currently stored; or will return 1 if there is a true boolean value; or will try to parse string value; in all negative cases it will return 0.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    asInt()
  - asString
```
public String asString()
```
    Converts current value to a string value. Containers which hold primitive values like boolean, double or integer will be just converted as is; UNDEFIEND or NULL containers will return empty string; OBJECT container will return special tag "[object Object]"; and ARRAY container will be recursively converted to a comma separated list and cyclic references will be ignored.
    
    Returns:
    
    string value, which represents current container.
    
    See Also:
    
    toString()
  - asString
```
public String asString(int index)
```
    Converts value, which is located in the specified position to a string value. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).asString();
    
    Parameters:
    
    index - position of value, which will be converted to string.
    
    Returns:
    
    string value, which represents current container.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    asString()
  - asString
```
public String asString(String property)
```
    Converts value, which is located in the specified property to a string value. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).asString();
    
    Parameters:
    
    property - name of the property, which value will be converted to string.
    
    Returns:
    
    string value, which represents current container.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    asString()
  - asList
```
public <T> List<T> asList(Class<T> clazz)
```
    Converts current ARRAY container to List. If current container holds any primitive value or String it return List with one element. In all other cases it will return empty list.
    
    Type Parameters:
    
    T - the type of the List element
    
    Parameters:
    
    clazz - class, which will as a type for a resulting List.
    
    Returns:
    
    List object, converted from ARRAY container; or just empty list.
    
    Throws:
    
    ClassCastException - if one of the values cannot be casted to a desired class.
  - asMap
```
public <T> Map<String,T> asMap(Class<T> clazz)
```
    Converts current OBJECT container to Map. For all other containers empty map will be returned. Resulting map key type will always be a String.
    
    Type Parameters:
    
    T - the type of the Map element
    
    Parameters:
    
    clazz - class, which will be used as a type for a resulting Map.
    
    Returns:
    
    Map object, converted from OBJECT container; or just empty map.
    
    Throws:
    
    ClassCastException - if one of the values cannot be casted to a desired class.
  - valueOf
```
public <T> T valueOf()
```
    Simply extracts value from the current container. If current container is not LITERAL, null value will be returned, otherwise stored value will be extracted.
    
    Type Parameters:
    
    T - the type of the value stored in the container
    
    Returns:
    
    casted value, which is stored in the current container.
    
    Throws:
    
    ClassCastException - if value cannot be casted to a desired class.
  - valueOf
```
public <T> T valueOf(int index)
```
    Simply extracts value from the specified position in the current container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).valueOf();
    
    Type Parameters:
    
    T - the type of the value stored in the container
    
    Parameters:
    
    index - position of value, which will be extracted.
    
    Returns:
    
    casted value, which is stored in the specified position of the current container.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    ClassCastException - if value cannot be casted to a desired class.
    
    See Also:
    
    valueOf()
  - valueOf
```
public <T> T valueOf(String property)
```
    Simply extracts value from the specified property in the current container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).valueOf();
    
    Type Parameters:
    
    T - the type of the value stored in the container
    
    Parameters:
    
    property - name of the property, which value will be extracted.
    
    Returns:
    
    casted value, which is stored in the specified property of the current container.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    ClassCastException - if value cannot be casted to a desired class.
    
    See Also:
    
    valueOf()
  - isArray
```
public boolean isArray()
```
    Checks if current container is ARRAY container.
    Javascript Note: can be used as a replacement of static javascript method Array. isArray(obj).
    
    Returns:
    
    true if current container is ARRAY container, false otherwise.
  - isArray
```
public boolean isArray(int index)
```
    Checks if value at specified position is ARRAY container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).isArray();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position is ARRAY container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    isArray()
  - isArray
```
public boolean isArray(String property)
```
    Checks if value in specified property is ARRAY container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).isArray();
    
    Parameters:
    
    property - name of the property, which value will be tested.
    
    Returns:
    
    true if value in specified property is ARRAY container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    isArray()
  - isBoolean
```
public boolean isBoolean()
```
    Checks if current container is BOOLEAN LITERAL container.
    Javascript Note: can be used as a replacement of expression
    typeof obj === "boolean"
    
    Returns:
    
    true if current container is BOOLEAN LITERAL container, false otherwise.
  - isBoolean
```
public boolean isBoolean(int index)
```
    Checks if value at specified position is BOOLEAN LITERAL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).isBoolean();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position is BOOLEAN LITERAL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    isBoolean()
  - isBoolean
```
public boolean isBoolean(String property)
```
    Checks if value in specified property is BOOLEAN LITERAL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).isBoolean();
    
    Parameters:
    
    property - name of the property, which value will be tested.
    
    Returns:
    
    true if value in specified property is BOOLEAN LITERAL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    isBoolean()
  - isObject
```
public boolean isObject()
```
    Checks if current container is OBJECT container. It also will return true for NULL and ARRAY containers.
    Javascript Note: can be used as a replacement of expression
    typeof obj === "object"
    
    Returns:
    
    true if current container is OBJECT, ARRAY or NULL container, false otherwise.
  - isObject
```
public boolean isObject(int index)
```
    Checks if value at specified position is OBJECT, ARRAY or NULL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).isObject();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position is OBJECT, ARRAY or NULL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    isObject()
  - isObject
```
public boolean isObject(String property)
```
    Checks if value in specified property is OBJECT, ARRAY or NULL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).isObject();
    
    Parameters:
    
    property - name of the property, which value will be tested.
    
    Returns:
    
    true if value in specified property is OBJECT, ARRAY or NULL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    isObject()
  - isNull
```
public boolean isNull()
```
    Checks if current container is NULL container.
    Javascript Note: can be used as a replacement of expression
    obj === null
    
    Returns:
    
    true if current container is NULL container, false otherwise.
  - isNull
```
public boolean isNull(int index)
```
    Checks if value at specified position is NULL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).isNull();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position is NULL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    isNull()
  - isNull
```
public boolean isNull(String property)
```
    Checks if value in specified property is NULL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).isNull();
    
    Parameters:
    
    property - name of the property, which value will be tested.
    
    Returns:
    
    true if value in specified property is NULL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    isNull()
  - isNumber
```
public boolean isNumber()
```
    Checks if current container is NUMBER LITERAL container.
    Javascript Note: can be used as a replacement of expression
    typeof obj === "number"
    
    Returns:
    
    true if current container is NUMBER LITERAL container, false otherwise.
  - isNumber
```
public boolean isNumber(int index)
```
    Checks if value at specified position is NUMBER LITERAL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).isNumber();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position is NUMBER LITERAL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    isNumber()
  - isNumber
```
public boolean isNumber(String property)
```
    Checks if value in specified property is NUMBER LITERAL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).isNumber();
    
    Parameters:
    
    property - name of the property, which value will be tested.
    
    Returns:
    
    true if value in specified property is NUMBER LITERAL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    isNumber()
  - isString
```
public boolean isString()
```
    Checks if current container is STRING LITERAL container.
    Javascript Note: can be used as a replacement of expression
    typeof obj === "string"
    
    Returns:
    
    true if current container is STRING LITERAL container, false otherwise.
  - isString
```
public boolean isString(int index)
```
    Checks if value at specified position is STRING LITERAL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).isString();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position is STRING LITERAL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    isString()
  - isString
```
public boolean isString(String property)
```
    Checks if value in specified property is STRING LITERAL container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).isString();
    
    Parameters:
    
    property - name of the property, which value will be tested.
    
    Returns:
    
    true if value in specified property is STRING LITERAL container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    isString()
  - isUndefined
```
public boolean isUndefined()
```
    Checks if current container is UNDEFINED container.
    Javascript Note: can be used as a replacement of expression
    obj === undefined
    
    Returns:
    
    true if current container is UNDEFINED container, false otherwise.
  - isUndefined
```
public boolean isUndefined(int index)
```
    Checks if value at specified position is UNDEFINED container. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).isUndefined();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position is UNDEFINED container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    isUndefined()
  - isUndefined
```
public boolean isUndefined(String property)
```
    Checks if value in specified property is UNDEFINED container. This method works as if invoking it were equivalent to evaluating the expression:
    get(property).isUndefined();
    
    Parameters:
    
    property - name of the property, which value will be tested.
    
    Returns:
    
    true if value in specified property is UNDEFINED container, false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    isUndefined()
  - test
```
public boolean test()
```
    Checks if current container can be resolved to true in "if" conditions. Following values will be considered as false: UNDEFINED, NULL, false, 0, "", null LITERAL, but all other values will be treated as true.
    Javascript Note: this method is a general way to emulate values checking in "if" conditions in JS. For example following expression:
    if (obj) { ... }
    can be replaced with something like this:
    if (obj.test()) { ... }
    
    Returns:
    
    true if current container holds a value, which can be positively resolved in "if" condition; false otherwise.
  - test
```
public boolean test(int index)
```
    Checks if value at specified position can be resolved to true in "if" conditions. This method works as if invoking it were equivalent to evaluating the expression:
    get(index).test();
    
    Parameters:
    
    index - position of value, which will be tested.
    
    Returns:
    
    true if value at specified position can be positively resolved in "if" condition; false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
    
    See Also:
    
    test()
  - test
```
public boolean test(String property)
```
    Checks if value in specified property can be resolved to true in "if" conditions. In most cases this method works the same as following expression:
    get(property).test();
    
    but it will work differently for built-in properties like "constructor" and "length" - it will check if getConstructor() returns null and if getLength(Integer) returns 0 accordingly.
    
    Parameters:
    
    property - name of the property, which will be tested.
    
    Returns:
    
    true if value in specified property can be positively resolved in "if" condition; false otherwise.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
    
    See Also:
    
    test()
  - get
```
public UniversalContainer get(int index)
```
    Reads a value from the current container located at specified index. If current container is a STRING LITERAL it will return container with a character located at specified position in the string. If index doesn't exist, UNDEFINED container will be returned. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Note: this method will first scan current container for an index and if nothing will be found it will scan prototype.
    Javascript Note: this method is a general way to access values by index, it emulates square brackets in JS. For example following expression:
    value = obj[index];
    can be replaced with something like this:
    value = obj.get(index);
    
    Parameters:
    
    index - position in the current container, which will be read.
    
    Returns:
    
    container, which is stored at specified position or UNDEFINED container if nothing was found.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
  - get
```
public UniversalContainer get(String property)
```
    Reads specified property from the current container. If property doesn't exist, UNDEFINED container will be returned. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Note: this method will first scan current container for a property and if nothing will be found it will scan prototype.
    Javascript Note: this method is a general way to access property, it emulates square brackets and dot notation in JS. For example following expressions:
    value = obj[property];
    
    value = obj.property;
    can be replaced with something like this:
    value = obj.get(property);
    
    Parameters:
    
    property - name of the property in the current container, which will be read.
    
    Returns:
    
    container, which is stored in specified property or UNDEFINED container if nothing was found.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
  - getConstructor
```
public ContainerConstructor getConstructor()
```
    Reads built-in "constructor" property. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Note: this method will first search current container for a constructor property and if nothing will be found it will search in prototype and so on.
    Warning: do not use this method, because it's not finalized yet, currently it's only used in Lodash.isEqual(UniversalContainer, Object) method.
    
    Returns:
    
    constructor or null if doesn't exist.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have constructor.
  - getLength
```
public Integer getLength()
```
    Reads built-in "length" property. This method is unsafe, because it can return null value if there is no length property, so it's better to use method getLength(Integer) instead. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Note: this method will first search current container for a length property and if nothing will be found it will search in prototype and so on.
    
    Returns:
    
    length or null if doesn't exist.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have length.
    
    See Also:
    
    getLength(Integer)
  - getLength
```
public Integer getLength(Integer defaultLength)
```
    Reads built-in "length" property. If length doesn't exist defaultValue will be returned instead. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Note: this method will first search current container for a length property and if nothing will be found it will search in prototype and so on.
    
    Parameters:
    
    defaultLength - the value, which will be returned if length doesn't exists.
    
    Returns:
    
    length or defaultValue if doesn't exist.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have length.
  - getProto
```
public UniversalContainer getProto()
```
    Returns current container's prototype.
    
    Returns:
    
    prototype container of the current container
  - set
```
public UniversalContainer set(int index,
                              Object value)
```
    Writes value in the current container under specified index. All raw values will be wrapped into corresponding containers. If current container is a LITERAL container nothing will happen, value won't be saved. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Javascript Note: this method is a general way to write values at specified index, it emulates square brackets in JS. For example following expression:
    obj[index] = value;
    can be replaced with something like this:
    obj.set(index, value);
    
    Parameters:
    
    index - position in the current container, where object will be stored.
    
    value - object, which will be stored in the current container under specified position.
    
    Returns:
    
    current container, this can be useful for a piped method call.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have indexes.
  - set
```
public UniversalContainer set(String property,
                              Object value)
```
    Writes value in the current container under specified property. All raw values will be wrapped into corresponding containers. If current container is a LITERAL container nothing will happen, value won't be saved. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Javascript Note: this method is a general way to write value under specified property, it emulates square brackets and dot notation in JS. For example following expressions:
    obj[property] = value;
    
    obj.property = value;
    can be replaced with something like this:
    obj.set(property, value);
    
    Parameters:
    
    property - name of the property, under which value will be stored.
    
    value - object, which will be stored in the current container.
    
    Returns:
    
    current container, this can be useful for a piped method call.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have properties.
  - setLength
```
public void setLength(int newLength)
```
    Overrides built-in "length" property. If new length is less than current one and current container is ARRAY, then all values outside of the array boundaries will be deleted. If value less than 0 method will throw ContainerException. The same exception will be thrown if current container is UNDEFINED or NULL.
    
    Parameters:
    
    newLength - non-negative integer value, which will override current length.
    
    Throws:
    
    ContainerException - if current container is UNDEFINED or NULL, since these containers can't have length.
  - concat
```
public UniversalContainer concat(Object... sources)
```
    This method has two different algorithms depending on the current container type:
    1) If current container is a STRING LITERAL, then this method will convert all sources to a string and will produce new STRING LITERAL container consisted of all strings appended one by one. This is a precise implementation of JS method String. prototype.concat().
    2) If current container is an ARRAY, then this method will create new ARRAY container, will add all values of the current container to the new one and will join all the sources one by one. Depending on the source value different logic will be applied during concatenation. If source is an ARRAY container or equivalent raw value, then its own values will be added instead of source itself, otherwise source will be added as a value to the end of new ARRAY container. This is a precise implementation of JS method Array. prototype.concat().
    3) For all other containers this method will throw ContainerException with a description that this method is not supported.
    Note: concatenating array(s)/value(s) will leave the originals untouched. Furthermore, any operation on the new ARRAY container (only if the element is not object reference) will have no effect on the original array(s)/value(s), and vice versa.
    
    Parameters:
    
    sources - list of values, that should be joined with the current container, all raw values will be wrapped into corresponding containers.
    
    Returns:
    
    new STRING LITERAL or ARRAY container (type will be same as a current container) with the joined values.
    
    Throws:
    
    ContainerException - if current container is not STRING LITERAL or ARRAY container.
  - create
```
public UniversalContainer create()
```
    Creates new OBJECT container, with the current container as a prototype. Method will work only for ARRAY, OBJECT and NULL containers and for all others it will throw ContainerException.
    Javascript Note: this method emulates static javascript method Object. create(). It's not a precise implementation since current method is not static and parameter propertiesObject is missing. As an example following expression:
    Object.create(obj);
    can be replaced with something like this:
    obj.create();
    
    Returns:
    
    new OBJECT container with the current container as a prototype.
    
    Throws:
    
    ContainerException - if current container is not ARRAY, OBJECT or NULL container.
  - delete
```
public void delete(int index)
```
    Removes an index from the current container. If there is no such index nothing will happen. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Note: this method mutates current OBJECT or ARRAY container.
    Javascript Note: this method emulates javascript delete operator. As an example following expression:
    delete obj[index];
    can be replaced with something like this:
    obj.delete(index);
    
    Parameters:
    
    index - position in the container, which will be removed.
    
    Throws:
    
    ContainerException - if current container is not ARRAY or OBJECT container.
  - delete
```
public void delete(String property)
```
    Removes a property from the current container. If there is no such property nothing will happen. If current container is UNDEFINED or NULL, method will throw ContainerException.
    Note: this method mutates current OBJECT or ARRAY container.
    Javascript Note: this method emulates javascript delete operator. As an example following expressions:
    delete obj[property];
    delete obj.property;
    can be replaced with something like this:
    obj.delete(property);
    
    Parameters:
    
    property - name of the property in the container, which will be removed.
    
    Throws:
    
    ContainerException - if current container is not ARRAY or OBJECT container.
  - has
```
public boolean has(int index)
```
    Checks if specified index exists in the current container. This method works as if invoking it were equivalent to evaluating the expression:
    has(index, true);
    
    Parameters:
    
    index - position of value, which will be checked.
    
    Returns:
    
    true if specified index exists in the current containter; false otherwise.
    
    See Also:
    
    has(int, boolean)
  - has
```
public boolean has(String property)
```
    Checks if specified property exists in the current container. This method works as if invoking it were equivalent to evaluating the expression:
    has(property, true);
    
    Parameters:
    
    property - name of the property, which will be checked.
    
    Returns:
    
    true if specified property exists in the current containter; false otherwise.
    
    See Also:
    
    has(String, boolean)
  - has
```
public boolean has(int index,
                   boolean own)
```
    Checks if specified index exists in the current container. If own parameter is true method will scan only current container for an index, otherwise it will also search among inherited indexes from the prototype. If current container is a STRING LITERAL this method will return true if index is equal or greater than 0 and less than string length.
    Javascript Note: this method is a wild combination of javascript standard method Object.prototype.hasOwnProperty() and two Lodash's methods has() and hasIn(). As an example following expressions:
    obj.hasOwnProperty(index);
    _.has(obj, index);
    can be replaced with something like this:
    obj.has(index, true);
    And following expression:
    _.hasIn(obj, index);
    can be replaced with something like this:
    obj.has(index, false);
    
    Parameters:
    
    index - position of value, which will be checked.
    
    own - if true method will scan only current container for an index; otherwise it will also search among inherited indexes from the prototype.
    
    Returns:
    
    true if index exists; false otherwise.
  - has
```
public boolean has(String property,
                   boolean own)
```
    Checks if specified property exists in the current container. If own parameter is true method will scan only current container for a property, otherwise it will also search among inherited properties from the prototype.
    Javascript Note: this method is a wild combination of javascript standard method Object.prototype.hasOwnProperty() and two Lodash's methods has() and hasIn(). As an example following expressions:
    obj.hasOwnProperty(property);
    _.has(obj, property);
    can be replaced with something like this:
    obj.has(property, true);
    And following expression:
    _.hasIn(obj, property);
    can be replaced with something like this:
    obj.has(property, false);
    
    Parameters:
    
    property - name of the property, which will be checked.
    
    own - if true method will scan only current container for a property; otherwise it will also search among inherited properties from the prototype.
    
    Returns:
    
    true if property exists; false otherwise.
  - indexOf
```
public int indexOf(Object value)
```
    This method has two different algorithms depending on the current container type:
    1) If current container is a STRING LITERAL, then method will convert given value to a STRING LITERAL and will return the index in the current string of the first occurence of the specified substring. If substring won't be found, then method will return -1. This is a precise implementation of JS method String. prototype.indexOf(), except parameter fromIndex isn't implemented. To find substring method checks not only current container, but the whole prototype chain.
    2) If current container is an ARRAY, then method will return first index at which a given value can be found in the ARRAY container. For comparison method equals(Object) will be used. If value won't be found, then method will return -1. This is almost a precise implementation of JS method Array. prototype.indexOf(), except parameter fromIndex isn't implemented. To find the value method checks not only current container, but the whole prototype chain.
    3) For all other containers this method will throw ContainerException with a description that this method is not supported.
    
    Parameters:
    
    value - any value that will be searched in the container.
    
    Returns:
    
    integer that represents index number in container or -1 if nothing is found.
    
    Throws:
    
    ContainerException - if current container is not STRING LITERAL or ARRAY container.
    
    See Also:
    
    equals(Object)
  - keys
```
public Set<String> keys()
```
    Returns a set of all own indexes/properties of the current container. This method works as if invoking it were equivalent to evaluating the expression:
    keys(true);
    
    Returns:
    
    unmodifiable set of all own container indexes/properties or empty set if there are no any own indexes/properties.
    
    See Also:
    
    keys(boolean)
  - keys
```
public Set<String> keys(boolean own)
```
    Returns a set of all indexes/properties of the current container. If own parameter is false, all own and all inherited indexes/properties will be returned.
    Javascript Note: this method is a wild combination of javascript standard method Object. keys() and Lodash's methods keys() and keysIn(). As an example following expressions:
    Object.keys(obj);
    _.keys(obj);
    can be replaced with something like this:
    obj.keys(true);
    And following expression:
    _.keysIn(obj);
    can be replaced with something like this:
    obj.keys(false);
    
    Parameters:
    
    own - if true only own indexes/properties will be returned, otherwise all indexes/properties will be returned, including inhereted ones.
    
    Returns:
    
    unmodifiable set of all container indexes/properties (if own parameter is false, all inherited indexes/properties also will be returned); if there are no any indexes/properties, empty set will be returned.
  - pop
```
public UniversalContainer pop()
```
    Removes the last value from the current container and returns removed value. This method will work only for ARRAY containers or containers, which have an ARRAY in their prototype chain, for all other containers this method will throw ContainerException. To get the value method checks not only current container, but the whole prototype chain.
    Note: this method mutates current container.
    Javascript Note: this is a precise implementation of javascript method Array. prototype.pop().
    
    Returns:
    
    value, which is the last in the array; UNDEFINED container will be returned if current container is empty.
    
    Throws:
    
    ContainerException - if current container is not ARRAY container or container, which doesn't have ARRAY in its prototype chain.
    
    See Also:
    
    push(Object...)
  - push
```
public int push(Object... values)
```
    Adds one or more values to the end of the current ARRAY container and returns new length. This method will work only for ARRAY containers or containers, which have an ARRAY in their prototype chain, for all other containers this method will throw ContainerException.
    Note: this method mutates current container.
    
    Javascript Note: this is a precise implementation of javascript method Array. prototype.push().
    
    Parameters:
    
    values - variable number values that will be added to the end of the current ARRAY container, can be any object (raw values, other containers etc).
    
    Returns:
    
    new length of the current container.
    
    Throws:
    
    ContainerException - if current container is not ARRAY container or container, which doesn't have ARRAY in its prototype chain.
    
    See Also:
    
    pop()
  - shift
```
public UniversalContainer shift()
```
    Removes the element at the zeroeth index and shifts the values at consecutive indexes down, then returns the removed value. If the length property is 0, UNDEFINED container is returned. This method will work only for ARRAY containers or containers, which have an ARRAY in their prototype chain, for all other containers this method will throw ContainerException. To get the value method checks not only current container, but the whole prototype chain.
    Note: this method mutates current container.
    
    Javascript Note: this is a precise implementation of javascript method Array. prototype.shift().
    
    Returns:
    
    container, which was the first in current ARRAY container or will return UNDEFINED container if current container is empty.
    
    Throws:
    
    ContainerException - if current container is not ARRAY container or container, which doesn't have ARRAY in its prototype chain.
  - splice
```
public UniversalContainer splice(int start,
                                 int deleteCount)
```
    Changes the content of th current ARRAY container by removing existing elements using start and deleteCount parameters. This method will work only for ARRAY containers or containers, which have an ARRAY in their prototype chain, for all other containers this method will throw ContainerException. To get the values method checks not only current container, but the whole prototype chain.
    Note: this method mutates current container.
    
    Javascript Note: this is almost a precise implementation of javascript method Array. prototype.splice(). The only difference is that current implementation doesn't add new elements.
    
    Parameters:
    
    start - index at which to start changing the ARRAY container. If greater than the length property, actual starting index will be set to the length of the ARRAY container. If negative, will begin that many elements from the end.
    
    deleteCount - an integer indicating the number of elements to remove from current ARRAY container.
    
    Returns:
    
    an ARRAY container with deleted elements.
    
    Throws:
    
    ContainerException - if current container is not ARRAY container or container, which doesn't have ARRAY in its prototype chain.
  - clone
```
public UniversalContainer clone()
```
    A shortcut to the Lodash.clone(UniversalContainer) method. This method works as if invoking it were equivalent to evaluating the expression:
    Lodash.clone(this);
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    cloned container.
  - deepEquals
```
public boolean deepEquals(Object other)
```
    A shortcut to the Lodash.isEqual(UniversalContainer, Object) method. This method works as if invoking it were equivalent to evaluating the expression:
    Lodash.isEqual(this, other);
    
    Parameters:
    
    other - value of any class to compare with the current container
    
    Returns:
    
    true if the current container and other value are equivalent; false otherwise.
  - extend
```
public UniversalContainer extend(UniversalContainer... sources)
```
    A shortcut to the Lodash.extend(UniversalContainer, UniversalContainer...) method. This method works as if invoking it were equivalent to evaluating the expression:
    Lodash.extend(this, sources);
    
    Note: This method mutates destination OBJECT container.
    
    Parameters:
    
    sources - containers, which will override properties in the destination container.
    
    Returns:
    
    current container with the overriden properties.
  - last
```
public UniversalContainer last()
```
    A shortcut to the Lodash.last(UniversalContainer) method. This method works as if invoking it were equivalent to evaluating the expression:
    Lodash.last(this);
    
    Returns:
    
    the last element of current container.
  - merge
```
public UniversalContainer merge(UniversalContainer... sources)
```
    A shortcut to the Lodash.merge(UniversalContainer, UniversalContainer...) method. This method works as if invoking it were equivalent to evaluating the expression:
    Lodash.merge(this, sources);
    
    Note: This method mutates destination OBJECT container.
    
    Parameters:
    
    sources - containers, which properties will be merged into the destination container.
    
    Returns:
    
    current container with the merged properties.
  - values
```
public UniversalContainer values()
```
    A shortcut to the Lodash.values(UniversalContainer) method. This method works as if invoking it were equivalent to evaluating the expression:
    Lodash.values(this);
    
    Returns:
    
    ARRAY container of property values.
  - equals
```
public boolean equals(Object other)
```
    Compares current container and passed value and returns true if they equal.
    Javascript Note: this is a precise implementation of javascript strict equality. Loose equality usualy not in use and won't be implemented.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - any value, that will be compared with the current container.
    
    Returns:
    
    true if current container and passed value equal; false otherwise.
    
    See Also:
    
    deepEquals(Object)
  - iterator
```
public Iterator<UniversalContainer> iterator()
```
    Creates iterator over current container values (if it's ARRAY or STRING) or keys (if OBJECT), which can be in for statement. Works on STRING, ARRAY and OBJECT containers and for all others it will return empty iterator. To get the values method checks not only current container, but the whole prototype chain. Returned iterator doesn't support remove method.
    Javascript Note: created to mimic javascript for, for in and each methods.
    
    Specified by:
    
    iterator in interface Iterable<UniversalContainer>
    
    Returns:
    
    iterator over current container values.
    
    See Also:
    
    keys(boolean)
  - toString
```
public String toString()
```
    Returns a string representation of the current container. It works almost the same as asString() method, the only difference is that current method will return "undefined" and "null" strings for UNDEFINED and NULL containers accordingly.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of current container.
    
    See Also:
    
    asString()

Class UniversalContainer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

UniversalContainer

UniversalContainer

UniversalContainer

UniversalContainer

UniversalContainer

Method Detail

asBoolean

asBoolean

asBoolean

asDouble

asDouble

asDouble

asInt

asInt

asInt

asString

asString

asString

asList

asMap

valueOf

valueOf

valueOf

isArray

isArray

isArray

isBoolean

isBoolean

isBoolean

isObject

isObject

isObject

isNull

isNull

isNull

isNumber

isNumber

isNumber

isString

isString

isString

isUndefined

isUndefined

isUndefined

test

test

test

get

get

getConstructor

getLength

getLength

getProto

set

set

setLength

concat

create

delete

delete

has

has

has

has

indexOf

keys

keys

pop

push

shift

splice

clone

deepEquals

extend