Class ParameterValue

    • Method Detail

      • integer

        public final Integer integer()

        A control parameter that is an integer.

        Returns:
        A control parameter that is an integer.
      • hasIntegerList

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

        public final List<Integer> integerList()

        A control parameter that is a list 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 hasIntegerList() method.

        Returns:
        A control parameter that is a list of integers.
      • doubleValue

        public final Double doubleValue()

        A control parameter that is a double.

        Returns:
        A control parameter that is a double.
      • string

        public final String string()

        A control parameter that is a string.

        Returns:
        A control parameter that is a string.
      • hasStringList

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

        public final List<String> stringList()

        A control parameter that is a list 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 hasStringList() method.

        Returns:
        A control parameter that is a list of strings.
      • booleanValue

        public final Boolean booleanValue()

        A control parameter that is a boolean.

        Returns:
        A control parameter that is a boolean.
      • enumValue

        public final String enumValue()

        A control parameter that is an enum.

        Returns:
        A control parameter that is an enum.
      • hasEnumList

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

        public final List<String> enumList()

        A control parameter that is a list of enums.

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

        Returns:
        A control parameter that is a list of enums.
      • 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)
      • fromInteger

        public static ParameterValue fromInteger​(Integer integer)
        Create an instance of this class with integer() initialized to the given value.

        A control parameter that is an integer.

        Parameters:
        integer - A control parameter that is an integer.
      • fromIntegerList

        public static ParameterValue fromIntegerList​(List<Integer> integerList)
        Create an instance of this class with integerList() initialized to the given value.

        A control parameter that is a list of integers.

        Parameters:
        integerList - A control parameter that is a list of integers.
      • fromDoubleValue

        public static ParameterValue fromDoubleValue​(Double doubleValue)
        Create an instance of this class with doubleValue() initialized to the given value.

        A control parameter that is a double.

        Parameters:
        doubleValue - A control parameter that is a double.
      • fromString

        public static ParameterValue fromString​(String string)
        Create an instance of this class with string() initialized to the given value.

        A control parameter that is a string.

        Parameters:
        string - A control parameter that is a string.
      • fromStringList

        public static ParameterValue fromStringList​(List<String> stringList)
        Create an instance of this class with stringList() initialized to the given value.

        A control parameter that is a list of strings.

        Parameters:
        stringList - A control parameter that is a list of strings.
      • fromBooleanValue

        public static ParameterValue fromBooleanValue​(Boolean booleanValue)
        Create an instance of this class with booleanValue() initialized to the given value.

        A control parameter that is a boolean.

        Parameters:
        booleanValue - A control parameter that is a boolean.
      • fromEnumValue

        public static ParameterValue fromEnumValue​(String enumValue)
        Create an instance of this class with enumValue() initialized to the given value.

        A control parameter that is an enum.

        Parameters:
        enumValue - A control parameter that is an enum.
      • fromEnumList

        public static ParameterValue fromEnumList​(List<String> enumList)
        Create an instance of this class with enumList() initialized to the given value.

        A control parameter that is a list of enums.

        Parameters:
        enumList - A control parameter that is a list of enums.