Class NumberValue

  • All Implemented Interfaces:
    Comparable<FieldValue>

    public class NumberValue
    extends FieldValue
    A FieldValue instance representing an arbitrary-precision numeric value. It is stored as a Java BigDecimal and the serialized format is the String value of that number.
    • Constructor Detail

      • NumberValue

        public NumberValue​(BigDecimal value)
        Creates a new instance.
        Parameters:
        value - the value to use
      • NumberValue

        public NumberValue​(String value)
        Creates a new instance from a String value
        Parameters:
        value - the value to use
        Throws:
        NumberFormatException - if the value is not a valid BigDecimal
    • Method Detail

      • getValue

        public BigDecimal getValue()
        Returns the number value of this object
        Returns:
        the number value
      • castAsDouble

        public double castAsDouble()
        Casts this number to a double, possibly with loss of information about magnitude, precision or sign.
        Overrides:
        castAsDouble in class FieldValue
        Returns:
        a double value
      • compareTo

        public int compareTo​(FieldValue other)
      • getString

        public String getString()
        Description copied from class: FieldValue
        Returns a String value for the field. The String value cannot be created for MapValue, ArrayValue and BinaryValue. String values that are coerced use Java rules for representation.
        Overrides:
        getString in class FieldValue
        Returns:
        a String value
      • toJson

        public String toJson​(JsonOptions options)
        Description copied from class: FieldValue
        Returns a JSON representation of the value using the options, if specified.
        Overrides:
        toJson in class FieldValue
        Parameters:
        options - configurable options used to affect the JSON output format of some data types. May be null.
        Returns:
        the JSON representation of this value.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object