com.github.jshaptic.js4j

Class Lodash

java.lang.Object

com.github.jshaptic.js4j.Lodash

public class Lodash
extends Object

Java port of the javascript's famous library Lodash. This class consists exclusively of static methods that operate on UniversalContainer containers.

Note: Implementation based on the Lodash 3.10.1 [https://lodash.com/license]

Method Summary

Modifier and Type	Method and Description
static UniversalContainer	clone(UniversalContainer value) Creates a shallow copy of the value.
static UniversalContainer	extend(UniversalContainer object, UniversalContainer... sources) Assigns own enumerable properties of source OBJECT container(s) to the destination OBJECT container.
static boolean	isArray(Object value) Checks if value is classified as an ARRAY container.
static boolean	isEqual(UniversalContainer value, Object other) Performs a deep comparison between two values to determine if they are equivalent.
static boolean	isNull(Object value) Checks if value is classified as a NULL container.
static boolean	isObject(Object value) Checks if value is classified as an OBJECT container.
static boolean	isUndefined(Object value) Checks if value is classified as a UNDEFINED container.
static UniversalContainer	last(UniversalContainer array) Gets the last element of enumerable container like ARRAY or STRING LITERAL.
static UniversalContainer	merge(UniversalContainer object, UniversalContainer... sources) Recursively merges own enumerable properties of the source OBJECT container(s), that don't resolve to UNDEFINED into the destination OBJECT container.
static UniversalContainer	merge(UniversalContainer object, ValueCustomizer customizer, UniversalContainer... sources) Recursively merges own enumerable properties of the source OBJECT container(s), that don't resolve to UNDEFINED into the destination OBJECT container.
static UniversalContainer	values(UniversalContainer object) Creates an ARRAY continer of the own enumerable string keyed property values of OBJECT container.

Methods inherited from class java.lang.Object

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

Method Detail

isArray

public static boolean isArray(Object value)

Checks if value is classified as an ARRAY container. ARRAY containers, instances of List and Set classes, and java arrays of any type are considered as arrays. For null values method will return false.

Parameters:

value - object of any class, which will be tested

Returns:

true if value is classified as ARRAY container; false otherwise.

isObject

public static boolean isObject(Object value)

Checks if value is classified as an OBJECT container. OBJECT and ARRAY containers, instances of Map, List and Set classes are considered as objects. For null values method will return false.

Parameters:

value - object of any class, which will be tested

Returns:

true if value is classified as OBJECT container; false otherwise.

isNull

public static boolean isNull(Object value)

Checks if value is classified as a NULL container. Non null NULL containers and null instances of all other classes are considered as nulls.

Parameters:

value - object of any class, which will be tested

Returns:

true if value is classified as NULL container; false otherwise.

isUndefined

public static boolean isUndefined(Object value)

Checks if value is classified as a UNDEFINED container. Any null values and UNDEFINED containers are considered as undefineds.

Parameters:

value - object of any class, which will be tested

Returns:

true if value is classified as UNDEFINED container; false otherwise.

isEqual

public static boolean isEqual(UniversalContainer value,
                              Object other)

Performs a deep comparison between two values to determine if they are equivalent.

Note: This method supports comparing all known containers, objects of primitive classes and classes like List, Set, Map, and also arrays of any type. OBJECT containers are compared by their own, not inherited, enumerable properties.

Parameters:

value - the container to compare

other - the other value of any class to compare

Returns:

true if the values are equivalent; false otherwise.

clone

public static UniversalContainer clone(UniversalContainer value)

Creates a shallow copy of the value. Nested containers are assigned by reference.

Parameters:

value - any container to clone

Returns:

cloned value

last

public static UniversalContainer last(UniversalContainer array)

Gets the last element of enumerable container like ARRAY or STRING LITERAL.

Parameters:

array - any enumerable container to query

Returns:

the last element of enumerable container

extend

public static UniversalContainer extend(UniversalContainer object,
                                        UniversalContainer... sources)

Assigns own enumerable properties of source OBJECT container(s) to the destination OBJECT container. Subsequent sources overwrite property assignments of previous sources.

Note: This method mutates destination OBJECT container.

Parameters:

object - destination container

sources - source containers, which will override properties in the destination container

Returns:

destination container with the overriden properties

merge

public static UniversalContainer merge(UniversalContainer object,
                                       UniversalContainer... sources)

Recursively merges own enumerable properties of the source OBJECT container(s), that don't resolve to UNDEFINED into the destination OBJECT container. This method works as if invoking it were equivalent to evaluating the expression:

 merge(object, null, sources)
 

Note: This method mutates destination OBJECT container.

Parameters:

object - destination container

sources - source containers, which properties will be merged into the destination container

Returns:

destination container with the merged properties

merge

public static UniversalContainer merge(UniversalContainer object,
                                       ValueCustomizer customizer,
                                       UniversalContainer... sources)

Recursively merges own enumerable properties of the source OBJECT container(s), that don't resolve to UNDEFINED into the destination OBJECT container. Subsequent sources overwrite property assignments of previous sources. If customizer is provided it's invoked to produce the merged values of the destination and source properties. If customizer returns UNDEFINED container merging is handled by the method instead. The customizer is invoked with two arguments: (objectValue, sourceValue).

Note: This method mutates destination OBJECT container.

Parameters:

object - destination container

customizer - instance of ValueCustomizer class with a custom logic, which will be aplied to every pair

sources - source containers, which properties will be merged into the destination container

Returns:

destination container with the merged properties

values

public static UniversalContainer values(UniversalContainer object)

Creates an ARRAY continer of the own enumerable string keyed property values of OBJECT container.

Parameters:

object - OBJECT container to query for values.

Returns:

ARRAY container of property values.