Class ArrayValue

    • Method Detail

      • hasBooleanValues

        public final boolean hasBooleanValues()
        For responses, this returns true if the service returned a value for the BooleanValues 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.
      • booleanValues

        public final List<Boolean> booleanValues()

        An array of Boolean 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 hasBooleanValues() method.

        Returns:
        An array of Boolean values.
      • hasLongValues

        public final boolean hasLongValues()
        For responses, this returns true if the service returned a value for the LongValues 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.
      • longValues

        public final List<Long> longValues()

        An array of integers.

        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 hasLongValues() method.

        Returns:
        An array of integers.
      • hasDoubleValues

        public final boolean hasDoubleValues()
        For responses, this returns true if the service returned a value for the DoubleValues 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.
      • doubleValues

        public final List<Double> doubleValues()

        An array of floating-point numbers.

        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 hasDoubleValues() method.

        Returns:
        An array of floating-point numbers.
      • hasStringValues

        public final boolean hasStringValues()
        For responses, this returns true if the service returned a value for the StringValues 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.
      • stringValues

        public final List<String> stringValues()

        An array of strings.

        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 hasStringValues() method.

        Returns:
        An array of strings.
      • hasArrayValues

        public final boolean hasArrayValues()
        For responses, this returns true if the service returned a value for the ArrayValues 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.
      • arrayValues

        public final List<ArrayValue> arrayValues()

        An array of arrays.

        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 hasArrayValues() method.

        Returns:
        An array of arrays.
      • 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)
      • fromBooleanValues

        public static ArrayValue fromBooleanValues​(List<Boolean> booleanValues)
        Create an instance of this class with booleanValues() initialized to the given value.

        An array of Boolean values.

        Parameters:
        booleanValues - An array of Boolean values.
      • fromLongValues

        public static ArrayValue fromLongValues​(List<Long> longValues)
        Create an instance of this class with longValues() initialized to the given value.

        An array of integers.

        Parameters:
        longValues - An array of integers.
      • fromDoubleValues

        public static ArrayValue fromDoubleValues​(List<Double> doubleValues)
        Create an instance of this class with doubleValues() initialized to the given value.

        An array of floating-point numbers.

        Parameters:
        doubleValues - An array of floating-point numbers.
      • fromStringValues

        public static ArrayValue fromStringValues​(List<String> stringValues)
        Create an instance of this class with stringValues() initialized to the given value.

        An array of strings.

        Parameters:
        stringValues - An array of strings.
      • fromArrayValues

        public static ArrayValue fromArrayValues​(List<ArrayValue> arrayValues)
        Create an instance of this class with arrayValues() initialized to the given value.

        An array of arrays.

        Parameters:
        arrayValues - An array of arrays.
      • type

        public ArrayValue.Type type()
        Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ArrayValue.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ArrayValue.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.