Package org.pipservices3.commons.data

Class AnyValue

java.lang.Object
org.pipservices3.commons.data.AnyValue
All Implemented Interfaces:
Serializable, Cloneable
public class AnyValue extends Object implements Serializable, Cloneable
Cross-language implementation of dynamic object what can hold value of any type. The stored value can be converted to different types using variety of accessor methods.

### Example ### 

 
 AnyValue value1 = new AnyValue("123.456");

 value1.getAsInteger();   // Result: 123
 value1.getAsString();    // Result: "123.456"
 value1.getAsFloat();     // Result: 123.456
See Also:

  • Constructor Details

    • AnyValue

      public AnyValue()

    • AnyValue

      public AnyValue(Object value)
      Creates a new instance of the object and assigns its value.
      Parameters:
      value - (optional) value to initialize this object.

    • AnyValue

      public AnyValue(AnyValue value)

  • Method Details

    • getTypeCode

      public TypeCode getTypeCode()
      Gets type code for the value stored in this object.
      Returns:
      type code of the object value.
      See Also:

    • getAsObject

      public Object getAsObject()
      Gets the value stored in this object without any conversions
      Returns:
      the object value.

    • setAsObject

      public void setAsObject(Object value)
      Sets a new value for this object
      Parameters:
      value - the new object value.

    • getAsNullableString

      public String getAsNullableString()
      Converts object value into a string or returns null if conversion is not possible.
      Returns:
      string value or null if conversion is not supported.
      See Also:

    • getAsString

      public String getAsString()
      Converts object value into a string or returns "" if conversion is not possible.
      Returns:
      string value or "" if conversion is not supported.
      See Also:

    • getAsStringWithDefault

      public String getAsStringWithDefault(String defaultValue)
      Converts object value into a string or returns default value if conversion is not possible.
      Parameters:
      defaultValue - the default value.
      Returns:
      string value or default if conversion is not supported.
      See Also:

    • getAsNullableBoolean

      public Boolean getAsNullableBoolean()
      Converts object value into a boolean or returns null if conversion is not possible.
      Returns:
      boolean value or null if conversion is not supported.
      See Also:

    • getAsBoolean

      public Boolean getAsBoolean()
      Converts object value into a boolean or returns false if conversion is not possible.
      Returns:
      string value or false if conversion is not supported.
      See Also:

    • getAsBooleanWithDefault

      public boolean getAsBooleanWithDefault(boolean defaultValue)
      Converts object value into a boolean or returns default value if conversion is not possible.
      Parameters:
      defaultValue - the default value.
      Returns:
      boolean value or default if conversion is not supported.
      See Also:

    • getAsNullableInteger

      public Integer getAsNullableInteger()
      Converts object value into an integer or returns null if conversion is not possible.
      Returns:
      integer value or null if conversion is not supported.
      See Also:

    • getAsInteger

      public int getAsInteger()
      Converts object value into an integer or returns 0 if conversion is not possible.
      Returns:
      integer value or 0 if conversion is not supported.
      See Also:

    • getAsIntegerWithDefault

      public int getAsIntegerWithDefault(int defaultValue)
      Converts object value into a integer or returns default value if conversion is not possible.
      Parameters:
      defaultValue - the default value.
      Returns:
      integer value or default if conversion is not supported.
      See Also:

    • getAsNullableLong

      public Long getAsNullableLong()
      Converts object value into a long or returns null if conversion is not possible.
      Returns:
      long value or null if conversion is not supported.
      See Also:

    • getAsLong

      public long getAsLong()
      Converts object value into a long or returns 0 if conversion is not possible.
      Returns:
      string value or 0 if conversion is not supported.
      See Also:

    • getAsLongWithDefault

      public long getAsLongWithDefault(long defaultValue)
      Converts object value into a long or returns default value if conversion is not possible.
      Parameters:
      defaultValue - the default value.
      Returns:
      long value or default if conversion is not supported.
      See Also:

    • getAsNullableFloat

      public Float getAsNullableFloat()
      Converts object value into a float or returns null if conversion is not possible.
      Returns:
      float value or null if conversion is not supported.
      See Also:

    • getAsFloat

      public float getAsFloat()
      Converts object value into a float or returns 0 if conversion is not possible.
      Returns:
      float value or 0 if conversion is not supported.
      See Also:

    • getAsFloatWithDefault

      public float getAsFloatWithDefault(float defaultValue)
      Converts object value into a float or returns default value if conversion is not possible.
      Parameters:
      defaultValue - the default value.
      Returns:
      float value or default if conversion is not supported.
      See Also:

    • getAsNullableDouble

      public Double getAsNullableDouble()
      Converts object value into a double or returns null if conversion is not possible.
      Returns:
      double value or null if conversion is not supported.
      See Also:

    • getAsDouble

      public double getAsDouble()
      Converts object value into a double or returns 0 if conversion is not possible.
      Returns:
      double value or 0 if conversion is not supported.
      See Also:

    • getAsDoubleWithDefault

      public double getAsDoubleWithDefault(double defaultValue)
      Converts object value into a double or returns default value if conversion is not possible.
      Parameters:
      defaultValue - the default value.
      Returns:
      double value or default if conversion is not supported.
      See Also:

    • getAsNullableDateTime

      public ZonedDateTime getAsNullableDateTime()
      Converts object value into a Date or returns null if conversion is not possible.
      Returns:
      ZonedDateTime value or null if conversion is not supported.
      See Also:

    • getAsDateTime

      public ZonedDateTime getAsDateTime()
      Converts object value into a Date or returns current date if conversion is not possible.
      Returns:
      ZonedDateTime value or current date if conversion is not supported.
      See Also:

    • getAsDateTimeWithDefault

      public ZonedDateTime getAsDateTimeWithDefault(ZonedDateTime defaultValue)
      Converts object value into a Date or returns default value if conversion is not possible.
      Parameters:
      defaultValue - the default value.
      Returns:
      ZonedDateTime value or default if conversion is not supported.
      See Also:

    • getAsNullableDuration

      public Duration getAsNullableDuration()

    • getAsDuration

      public Duration getAsDuration()

    • getAsDurationWithDefault

      public Duration getAsDurationWithDefault(Duration defaultValue)

    • getAsNullableEnum

      public <T extends Enum<T>> T getAsNullableEnum(Class<T> type)

    • getAsEnum

      public <T extends Enum<T>> T getAsEnum(Class<T> type)

    • getAsEnumWithDefault

      public <T extends Enum<T>> T getAsEnumWithDefault(Class<T> type, T defaultValue)

    • getAsNullableType

      public <T> T getAsNullableType(Class<T> type)
      Converts object value into a value defined by specied typecode. If conversion is not possible it returns null.
      Parameters:
      type - the Class type that defined the type of the result
      Returns:
      value defined by the typecode or null if conversion is not supported.
      See Also:

    • getAsType

      public <T> T getAsType(Class<T> type)
      Converts object value into a value defined by specied typecode. If conversion is not possible it returns default value for the specified type.
      Parameters:
      type - the Class type that defined the type of the result
      Returns:
      value defined by the typecode or type default value if conversion is not supported.
      See Also:

    • getAsTypeWithDefault

      public <T> T getAsTypeWithDefault(Class<T> type, T defaultValue)
      Converts object value into a value defined by specied typecode. If conversion is not possible it returns default value.
      Parameters:
      type - the Class type that defined the type of the result
      defaultValue - the default value
      Returns:
      value defined by the typecode or type default value if conversion is not supported.
      See Also:

    • getAsArray

      public AnyValueArray getAsArray()
      Converts object value into an AnyArray or returns empty AnyArray if conversion is not possible.
      Returns:
      AnyArray value or empty AnyArray if conversion is not supported.
      See Also:

    • getAsMap

      public AnyValueMap getAsMap()
      Converts object value into AnyMap or returns empty AnyMap if conversion is not possible.
      Returns:
      AnyMap value or empty AnyMap if conversion is not supported.
      See Also:

    • equals

      public boolean equals(Object obj)
      Compares this object value to specified specified value. When direct comparison gives negative results it tries to compare values as strings.
      Overrides:
      equals in class Object
      Parameters:
      obj - the value to be compared with.
      Returns:
      true when objects are equal and false otherwise.

    • equalsAsType

      public <T> boolean equalsAsType(Class<T> type, Object obj)
      Compares this object value to specified specified value. When direct comparison gives negative results it converts values to type specified by type code and compare them again.
      Parameters:
      type - the Class type that defined the type of the result
      obj - the value to be compared with.
      Returns:
      true when objects are equal and false otherwise.
      See Also:

    • clone

      public Object clone()
      Creates a binary clone of this object.
      Overrides:
      clone in class Object
      Returns:
      a clone of this object.

    • toString

      public String toString()
      Gets a string representation of the object.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the object.
      See Also:

    • hashCode

      public int hashCode()
      Gets an object hash code which can be used to optimize storing and searching.
      Overrides:
      hashCode in class Object
      Returns:
      an object hash code.