Class FieldTypeDetails

    • Method Detail

      • fieldType

        public final String fieldType()

        The type of field, such as string, integer, date, and so on.

        Returns:
        The type of field, such as string, integer, date, and so on.
      • filterOperators

        public final List<Operator> filterOperators()

        The list of operators supported by a field.

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

        Returns:
        The list of operators supported by a field.
      • hasFilterOperators

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

        public final List<String> filterOperatorsAsStrings()

        The list of operators supported by a field.

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

        Returns:
        The list of operators supported by a field.
      • hasSupportedValues

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

        public final List<String> supportedValues()

        The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

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

        Returns:
        The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".
      • valueRegexPattern

        public final String valueRegexPattern()

        The regular expression pattern for the field name.

        Returns:
        The regular expression pattern for the field name.
      • supportedDateFormat

        public final String supportedDateFormat()

        The date format that the field supports.

        Returns:
        The date format that the field supports.
      • fieldValueRange

        public final Range fieldValueRange()

        The range of values this field can hold.

        Returns:
        The range of values this field can hold.
      • fieldLengthRange

        public final Range fieldLengthRange()

        This is the allowable length range for this field's value.

        Returns:
        This is the allowable length range for this field's 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)