AnyValueMap

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

Implements: ICloneable

Description

The AnyValueMap class provides a cross-language implementation of a dynamic map (dictionary) 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 map and assigns its value.

public AnyValueMap(Map values)

  • values: Map - (optional) values to initialize this map.

Instance methods

append

Appends new elements to this map.

public void append(Map map)

  • map: Map - map with elements to be added.

clone

Creates a binary clone of this object.

public Object clone()

  • returns: Object - clone of this object.

get

Gets a map’s element specified by its key.

public Object get(String key)

  • key: String - key of the element to get.
  • returns: Object - value of the map’s element.

getAsArray

Converts a map’s element into an AnyValueArray object or returns an empty AnyValueArray object if theconversion is not possible.
See AnyValueArray, AnyValueArray.fromValue

public AnyValueArray getAsArray(String key)

  • key: String - key of the element to get.
  • returns: AnyValueArray - AnyValueArray value of the element or empty AnyValueArray object if the conversion is not supported.

getAsArrayWithDefault

Converts a map’s element into an AnyValueArray object or returns a given default value if the conversion is not possible.
See AnyValueArray

public AnyValueArray getAsArrayWithDefault(String key, AnyValueArray defaultValue)

  • key: String - key of 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 a map’s element into a boolean or returns false if the conversion is not possible.

public boolean getAsBoolean(String key)

  • key: String - key of the element to get.
  • returns: boolean - value of the element or false if the conversion is not supported.

getAsBooleanWithDefault

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

public boolean getAsBooleanWithDefault(String key, boolean defaultValue)

  • key: String - key of the element to get.
  • defaultValue: boolean - default value
  • returns: boolean - boolean value of the element or given default value if the conversion is not supported.

getAsDateTime

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

public ZonedDateTime getAsDateTime(String key)

  • key: String - akey of the element to get.
  • returns: ZonedDateTime - ZonedDateTime value of the element or the current date if the conversion is not supported.

getAsDateTimeWithDefault

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

public ZonedDateTime getAsDateTimeWithDefault(String key, ZonedDateTime defaultValue)

  • key: String - key of the element to get.
  • defaultValue: ZonedDateTime - default value
  • returns: ZonedDateTime - ZonedDateTime value of the element or given default value if the conversion is not supported.

getAsDouble

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

public double getAsDouble(String key)

  • key: String - key of the element to get.
  • returns: double - double value of the element or 0 if the conversion is not supported.

getAsDoubleWithDefault

Converts a map’s element into a double or returns a given default value if the conversion is not possible.
See DoubleConverter.toDoubleWithDefault

public double getAsDoubleWithDefault(String key, double defaultValue)

  • key: String - key 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 a map’s element into a float or returns 0 if conversion the is not possible.

public float getAsFloat(String key)

  • key: String - key of the element to get.
  • returns: float - float value of the element or 0 if the conversion is not supported.

getAsFloatWithDefault

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

public float getAsFloatWithDefault(String key, float defaultValue)

  • key: String - key of the element to get.
  • defaultValue: float - default value
  • returns: float - flaot value of the element or given default value if the conversion is not supported.

getAsInteger

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

public int getAsInteger(String key)

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

getAsIntegerWithDefault

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

public int getAsIntegerWithDefault(String key, int defaultValue)

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

getAsLong

Converts a map’s element into a long or returns 0 if the conversion is not possible.
See IntegerConverter.toIntegerWithDefault

public long getAsLong(String key)

  • key: String - key of the element to get.
  • returns: long - long value of the element or 0 if the conversion is not supported.

getAsLongWithDefault

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

public long getAsLongWithDefault(String key, long defaultValue)

  • key: String - key of the element to get.
  • defaultValue: long - default value
  • returns: long - long value of the element or default value if the conversion is not supported.

getAsMap

Converts a map’s element into an AnyValueMap object or returns an empty AnyValueMap object if the conversion is not possible.
See LongConverter.toLongWithDefault

public AnyValueMap getAsMap(String key)

  • key: String - key of the element to get.
  • returns: AnyValueMap - AnyValueMap value of the element or empty AnyValueMap object if the conversion is not supported.

getAsMapWithDefault

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

public AnyValueMap getAsMapWithDefault(String key, AnyValueMap defaultValue)

  • key: String - key of the 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 a map’s element into an AnyValueArray object or returns null if the conversion is not possible.
See AnyValueMap, AnyValueMap.fromValue

public AnyValueMap getAsNullableArray(String key)

  • key: String - key of the element to get.
  • returns: AnyValueMap - AnyValueArray value of the element or null if the conversion is not supported.

getAsNullableBoolean

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

public Boolean getAsNullableBoolean(String key)

  • key: String - key of the element to get.
  • returns: Boolean - boolean value of the element or null if the conversion is not supported.

getAsNullableDateTime

Converts map element into a long or returns a given default value if the conversion is not possible.
See DateTimeConverter.toNullableDateTime

public ZonedDateTime getAsNullableDateTime(String key)

  • key: String - key of element to get.
  • returns: ZonedDateTime - ZonedDateTime value of the element or null if the conversion is not supported.

getAsNullableDouble

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

public Double getAsNullableDouble(String key)

  • key: String - key of element to get.
  • returns: Double - double value of the element or null if the conversion is not supported.

getAsNullableFloat

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

public Float getAsNullableFloat(String key)

  • key: String - key of the element to get.
  • returns: Float - float value of the element or null if the conversion is not supported.

getAsNullableInteger

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

public Integer getAsNullableInteger(String key)

  • key: string - key of element to get.
  • returns: number - integer value of the element or null if the conversion is not supported.

getAsNullableLong

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

public Long getAsNullableLong(String key)

  • key: String - key of the element to get.
  • returns: Long - long value of the element or null if the conversion is not supported.

getAsNullableMap

Converts a map’s element into an AnyValueMap object or returns null if the conversion is not possible.

public AnyValueMap getAsNullableMap(String key)

  • key: String - key of the element to get.
  • returns: AnyValueMap - AnyValueMap value of the element or null if the conversion is not supported.

getAsNullableString

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

public String getAsNullableString(String key)

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

getAsNullableType

Converts a map 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, String key)

  • type: Class - TypeCode that defines the type of the result.
  • key: String - key of the element to get.
  • returns: T - element’s value defined by the type code or null if the conversion is not supported.

getAsObject

Gets the value stored in a map’s element without any conversions. When the element’s key is not defined, it returns the entire map value.

public Object getAsObject(String key)

  • key: String - (optional) key of the element to get
  • returns: Object - element’s value or value of the map when the index is not defined.

getAsString

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

public String getAsString(String key)

  • key: String - key of the element to get.
  • returns: String - string value of the element or "" if the conversion is not supported.

getAsStringWithDefault

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

public String getAsStringWithDefault(String key, String defaultValue)

  • key: String - key 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 a map’s element into a value defined by a specified type code. If the conversion is not possible, it returns the default value for the specified type.

public T getAsType(Class type, String key)

  • type: Class - TypeCode that defines the type of the result.
  • key: String - key of the element to get.
  • returns: T - element’s value defined by the typecode or default if the conversion is not supported.

getAsTypeWithDefault

Converts a map’s element into a value defined by a specified type code. If the conversion is not possible, it returns a given default value.
See TypeConverter.toTypeWithDefault

public T getAsTypeWithDefault(Class type, String key, T defaultValue)

  • type: Class - type that defines the type of the result
  • key: String - key of element to get.
  • defaultValue: T - default value
  • returns: T - element’s value defined by the typecode or default value if the conversion is not supported.

getAsValue

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

public AnyValue getAsValue(String key)

  • key: String - key of the element to get.
  • returns: AnyValue -AnyValue value of the element or empty AnyValue object if the conversion is not supported.

getKeys

Gets the keys of all elements stored in this map.

public List getKeys()

  • returns: List - list with all keys.

length

Gets the number of elements stored in this map.

public int length()

  • returns: int - number of elements in this map.

setAsObject

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

public void setAsObject(String key, Object value)

  • key: String - (optional) key of the element to set
  • value: Object - new element or map value.

toString

Gets a string representation of the object. The result is a semicolon-separated list of key-value pairs as “key1=value1;key2=value2;key=value3”

public String toString()

  • returns: String - string representation of the object.

Static methods

fromMaps

Creates a new AnyValueMap object by merging two or more maps. Maps defined later in the list override values from previously defined maps.

public static AnyValueMap fromMaps(Map… maps)

  • maps: Map… - array of maps to be merged
  • returns: AnyValueMap - newly created AnyValueMap object.

fromTuples

Creates a new AnyValueMap object from a list of key-value pairs called tuples.

public static AnyValueMap fromTuples(Object… tuples)

  • tuples: Object… - list of values where odd elements are keys and the following even elements are values.
  • returns: AnyValueMap - newly created AnyValueArray object.

fromTuplesArray

Creates a new AnyValueMap object from a list of key-value pairs called tuples. The method is similar to fromTuples but tuples are passed as array instead of parameters.

public static AnyValueMap fromTuplesArray(Object[] tuples)

  • tuples: Object[] - list of values where odd elements are keys and the following even elements are values.
  • returns: AnyValueMap - newly created AnyValueArray object.

fromValue

Converts a specified value into an AnyValueMap object.

public static AnyValueMap fromValue(Object value)

  • value: Object - value to be converted
  • returns: AnyValueMap - newly created AnyValueMap object.

Examples

{
  AnyValueMap value1 = new AnyValueMap(new HashMap<String, Object>{
  { put("key1", 1);
  	 put("key2", "123.456"); 
    put("key3",  "2018-01-01") 
  }
  });
  
  value1.getAsBoolean("key1");   // Result: true
  value1.getAsInteger("key2");   // Result: 123
  value1.getAsFloat("key2");     // Result: 123.456
  value1.getAsDateTime("key3");  // Result: new Date(2018,0,1)
  }

See also