Class NullValue

  • All Implemented Interfaces:
    Comparable<FieldValue>

    public class NullValue
    extends FieldValue
    A FieldValue instance representing a null or missing value in a fully-typed schema. This type only exists in index keys on a fully-typed field and never inside indexed JSON.
    • Method Detail

      • getInstance

        public static NullValue getInstance()
        Returns an instance (singleton) of NullValue.
        Returns:
        the 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