AnyValueArray

Cross-language implementation of a dynamic array object that can hold values of any type. It also provides methods to convert the stored values to different types.

Extends: Array<any>

Implements: ICloneable

Description

The AnyValueArray class provides a cross-language implementation of a dynamic array object that can hold values of any type. In addition, it provides several methods to convert the stored values to different types, such as boolean, integer or datetime.

Constructors

Creates a new instance of the array and assigns its value.

public AnyValueArray(Object[] values)

values: Object[] - (optional) values used to initialize this array.

Instance methods

append

Appends new elements to this array.

public void append(Object[] elements)

elements: Object[] - list of elements to be added.

clone

Creates a binary clone of this object.

public Object clone()

returns: Object - clone of this object.

contains

Checks if this array contains a value. The check uses direct comparison between the elements of the array and the specified value.

public boolean contains(Object value)

value: Object - value to be checked
returns: boolean - true if this array contains the value or false otherwise.

containsAsType

Checks if this array contains a value. The check converts elements and the value to type specified by type code before comparison.
See TypeConverter.toType, TypeConverter.toNullableType

public boolean containsAsType(Class type, Object value)

type: Class - type code that defines a type to convert values before comparison
value: Object - value to be checked
returns: boolean - true if this array contains the value or false otherwise.

getAsArray

Converts array element into an AnyValueArray or returns an empty AnyValueArray if the conversion is not possible.

public AnyValueArray getAsArray(int index)

index: AnyValueArray - index of the element to get.
returns: AnyValueArray - AnyValueArray value of the element or empty AnyValueArray if the conversion is not supported.

getAsArrayWithDefault

Converts array element into an AnyValueArray or returns a givne default value if conversion is not possible.

public AnyValueArray getAsArrayWithDefault(int index, AnyValueArray defaultValue)

index: int - index of the element to get.
defaultValue: AnyValueArray - default value
returns: AnyValueArray - AnyValueArray value of the element or default value if the conversion is not supported.

getAsBoolean

Converts an array’s element into a boolean or returns false if the conversion is not possible.

public Boolean getAsBoolean(int index)

index: int - index of the element to get.
returns: Boolean - boolean value of the element or false if the conversion is not supported.

getAsBooleanWithDefault

Converts an array’s element into a boolean or returns a given default value if the conversion is not possible.
See BooleanConverter.toBooleanWithDefault

public boolean getAsBooleanWithDefault(int index, boolean defaultValue

index: int - index of the element to get.
defaultValue: boolean - default value
returns: boolean - boolean value of the element or default value if the conversion is not supported.

getAsDateTime

Converts an array’s element into Date or returns the current date if the conversion is not possible.

public ZonedDateTime getAsDateTime(int index)

index: int - index of the element to get.
returns: ZonedDateTime - ZonedDateTime value ot the element or the current date if the conversion is not supported.

getAsDateTimeWithDefault

Converts an array’s element into a Date or returns a given default value if the conversion is not possible.
See DateTimeConverter.toDateTimeWithDefault

public ZonedDateTime getAsDateTimeWithDefault(int index, ZonedDateTime defaultValue)

index: int - index of the element to get.
defaultValue: ZonedDateTime - default value
returns: ZonedDateTime - ZonedDateTime value ot the element or given default value if theconversion is not supported.

getAsDouble

Converts an array’s element into a double or returns 0 if the conversion is not possible.

public double getAsDouble(int index)

index: int - index of element to get.
returns: double - double value of the element or 0 if the conversion is not supported.

getAsDoubleWithDefault

Converts an array’s element into a double or returns a given default value if the conversion is not possible.

public double getAsDoubleWithDefault(int index, double defaultValue)

index: int - index of the element to get.
defaultValue: double - default value
returns: double - double value of the element or given default value if the conversion is not supported.

getAsFloat

Converts an array’s element into a float or returns 0 if the conversion is not possible.

public float getAsFloat(int index)

index: int - index of the element to get.
returns: float - float value of the element or 0 if the conversion is not supported.

getAsFloatWithDefault

Converts an array’s element into a float or returns a given default value if the conversion is not possible.
See FloatConverter.toFloatWithDefault

public float getAsFloatWithDefault(int index, float defaultValue)

index: int - index of the element to get.
defaultValue: float - default value
returns: float - float value of the element or given default value if the conversion is not supported.

getAsInteger

Converts an array’s element into an integer or returns 0 if the conversion is not possible.

public int getAsInteger(int index)

index: int - index of the element to get.
returns: int - integer value of the element or 0 if the conversion is not supported.

getAsIntegerWithDefault

Converts an array’s element into an integer or returns a given default value if the conversion is not possible.
See IntegerConverter.toIntegerWithDefault

public int getAsIntegerWithDefault(int index, int defaultValue)

index: int - index of the element to get.
defaultValue: int - default value
returns: int - integer value of the element or default value if the conversion is not supported.

getAsLong

Converts an array’s element into a long or returns 0 if the conversion is not possible.

public long getAsLong(int index)

index: int - index of the element to get.
returns: long - long value ot the element or 0 if the conversion is not supported.

getAsLongWithDefault

Converts an array’s element into a long or returns a given default value if the conversion is not possible.
See LongConverter.toLongWithDefault

public long getAsLongWithDefault(int index, long defaultValue)

index: int - index of the element to get.
defaultValue: long - default value
returns: long - long value of the element or given default value if the conversion is not supported.

getAsMap

Converts an array’s element into an AnyValueMap object or returns an empty AnyValueMap object if the conversion is not possible.
See AnyValueMap, AnyValueMap.fromValue

public AnyValueMap getAsMap(int index)

index: int - index of the element to get.
returns: AnyValueMap - AnyValueMap value of the element or empty AnyValueMap object if conversion is not supported.

getAsMapWithDefault

Converts an array’s element into an AnyValueMap oject or returns a given default value if the conversion is not possible.

public AnyValueMap getAsMapWithDefault(int index, AnyValueMap defaultValue)

index: int - index of element to get.
defaultValue: AnyValueMap - default value
returns: AnyValueMap - AnyValueMap value of the element or given default value if the conversion is not supported.

getAsNullableArray

Converts an array’s element into an AnyValueArray object or returns null if the conversion is not possible.

public AnyValueArray getAsNullableArray(int index)

index: int - index of the element to get.
returns: AnyValueArray - AnyValueArray value of the element or null if the conversion is not supported.

getAsNullableBoolean

Converts an array’s element into a boolean or returns null if the conversion is not possible.
See BooleanConverter.toNullableBoolean

public Boolean getAsNullableBoolean(int index)

index: int - index of the element to get.
returns: Boolean - boolean value of the element or null if the conversion is not supported.

getAsNullableDateTime

Converts an array’s element into a Date or returns null if the conversion is not possible.
See DateTimeConverter.toNullableDateTime

public ZonedDateTime getAsNullableDateTime(int index)

index: int- index of the element to get.
returns: ZonedDateTime - ZonedDateTime value of the element or null if the conversion is not supported.

getAsNullableDouble

Converts an array’s element into a double or returns null if the conversion is not possible.
See DoubleConverter.toNullableDouble

public Double getAsNullableDouble(int index)

index: int - index of the element to get.
returns: Double - double value of the element or null if the conversion is not supported.

getAsNullableFloat

Converts an array’s element into a float or returns null if the conversion is not possible.
See FloatConverter.toNullableFloat

public Float getAsNullableFloat(int index)

index: int - index of the element to get.
returns: Float - float value of the element or null if the conversion is not supported.

getAsNullableInteger

Converts an array’s element into a float or returns null if the conversion is not possible.
See IntegerConverter.toNullableInteger

public Integer getAsNullableInteger(int index)

index: int - index of the element to get.
returns: Integer - integer value of the element or null if the conversion is not supported.

getAsNullableLong

Converts an array’s element into a long or returns null if the conversion is not possible.
See LongConverter.toNullableLong

publicLong getAsNullableLong(int index)

index: int - index of the element to get.
returns: Long - long value of the element or null if the conversion is not supported.

getAsNullableMap

Converts an array’s element into a long or returns null if the conversion is not possible.
See AnyValueMap, AnyValueMap

public AnyValueMap getAsNullableMap(int index)

index: int - index of the element to get.
returns: AnyValueMap - AnyValueMap value of the element or null if the conversion is not supported.

getAsNullableString

Converts an array’s element into a string or returns null if the conversion is not possible.
See StringConverter.toNullableString,

public String getAsNullableString(int index)

index: int - index of the element to get.
returns: String - string value of the element or null if the conversion is not supported.

getAsNullableType

Converts an array’s element into a value defined by a specified typecode. If conversion is not possible, it returns null.
See TypeConverter.toNullableType

public T getAsNullableType(Class type, int index)

type: Class - type that defines the type of the result
index: int - index of the element to get.
returns: T - element value defined by the typecode or null if the conversion is not supported.

getAsObject

Gets the value stored in an array element without any conversion. When the element’s index is not defined, it returns the entire array value.

public Object getAsObject(int index)

index: int - (optional) index of the element to get
returns: Object - element value or value of the array when the index is not defined.

getAsString

Converts an array’s element into a string or returns "" if the conversion is not possible.

public String getAsString(int index)

index: int - index of the element to get.
returns: String - string value ot the element or "" if the conversion is not supported.

getAsStringWithDefault

Converts an array’s element into a string or returns a given default value if the conversion is not possible.
See StringConverter.toStringWithDefault

public String getAsStringWithDefault(int index, String defaultValue)

index: int - index of the element to get.
defaultValue: String - default value
returns: String - string value of the element or given default value if the conversion is not supported.

getAsType

Converts an array’s element into a value defined by a specified typecode. If conversion is not possible, it returns a given default value for the specified type.

public T getAsType(Class type, int index)

type: Class - TypeCode that defines the type of the result.
index: int - index of the element to get.
returns: T - element value defined by the typecode or given default if the conversion is not supported.

getAsTypeWithDefault

Converts an array’s element into a value defined by a specified typecode. If conversion is not possible it returns default value for the specified type.
See TypeConverter.toTypeWithDefault

public T getAsTypeWithDefault(Class type, int index, T defaultValue)

type: Class - TypeCode that defines the type of the result
index: int - index of the element to get.
defaultValue: T - default value
returns: T - element value defined by the typecode or given default value if the conversion is not supported.

getAsValue

Converts an array’s element into an AnyValue object or returns an empty AnyValue object if the conversion is not possible.
See AnyValue, AnyValues.constructors

public AnyValue getAsValue(int index)

index: int - index of element to get.
returns: AnyValue - AnyValue value of the element or empty AnyValue object if the conversion is not supported.

put

Puts a new value into an array’s element specified by its index.

public void put(int index, Object value)

index: int - index of the element to put.
value: Object - new value for the array’s element.

setAsObject

Sets a new value to an array’s element specified by its index. When the index is not defined, it resets the entire array value. This method has double purpose because method overrides are not supported in JavaScript.
See ArrayConverter.toArray

public void setAsObject(int index, Object value)

index: int - (optional) index of the element to set.
value: Object - new element or array’s value.

toString

Gets a string representation of the object. The result is a comma-separated list of string representations of individual elements as “value1,value2,value3”
See StringConverter.toString

public String toString()

returns: String - string representation of the object.

Static methods

fromString

Splits a specified string into elements using a separator and assigns the elements to a newly created AnyValueArray.

public static AnyValueArray fromString(String values, String separator, boolean removeDuplicates)

values: String - string value to be split and assigned to an AnyValueArray object.
separator: String - separator to split the string.
removeDuplicates: boolean - (optional) true to remove duplicated elements.
returns: AnyValueArray - newly created AnyValueArray object.

fromValue

Splits a specified string into elements using a separator and assigns the elements to a newly created AnyValueArray.
See ArrayConverter.toNullableArray

public static AnyValueArray fromValue(Object value)

values: Object - value to be converted
returns: AnyValueArray - newly created AnyValueArray object.

fromValues

Creates a new AnyValueArray object from a list of values.

public static AnyValueArray fromValues(Object… values)

values: Object… - list of values used to initialize the created AnyValueArray object.
returns: AnyValueArray - newly created AnyValueArray object.

Examples

{
  AnyValueArray value1 = new AnyValueArray(new Object[]{1, "123.456", "2018-01-01"});
 
  value1.getAsBoolean(0);   // Result: true
  value1.getAsInteger(1);   // Result: 123
  value1.getAsFloat(1);     // Result: 123.456
  value1.getAsDateTime(2);  // Result: new Date(2018,0,1)
  }