Class DataValue

    • Method Detail

      • booleanValue

        public final Boolean booleanValue()

        A Boolean value.

        Returns:
        A Boolean value.
      • doubleValue

        public final Double doubleValue()

        A double value.

        Returns:
        A double value.
      • integerValue

        public final Integer integerValue()

        An integer value.

        Returns:
        An integer value.
      • longValue

        public final Long longValue()

        A long value.

        Returns:
        A long value.
      • stringValue

        public final String stringValue()

        A string value.

        Returns:
        A string value.
      • hasListValue

        public final boolean hasListValue()
        For responses, this returns true if the service returned a value for the ListValue property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • listValue

        public final List<DataValue> listValue()

        A list of multiple values.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasListValue() method.

        Returns:
        A list of multiple values.
      • hasMapValue

        public final boolean hasMapValue()
        For responses, this returns true if the service returned a value for the MapValue property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • mapValue

        public final Map<String,​DataValue> mapValue()

        An object that maps strings to multiple DataValue objects.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMapValue() method.

        Returns:
        An object that maps strings to multiple DataValue objects.
      • relationshipValue

        public final RelationshipValue relationshipValue()

        A value that relates a component to another component.

        Returns:
        A value that relates a component to another component.
      • expression

        public final String expression()

        An expression that produces the value.

        Returns:
        An expression that produces the value.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)