Class FieldConfig

    • Method Detail

      • label

        public final String label()

        The label for the field.

        Returns:
        The label for the field.
      • position

        public final FieldPosition position()

        Specifies the field position.

        Returns:
        Specifies the field position.
      • excluded

        public final Boolean excluded()

        Specifies whether to hide a field.

        Returns:
        Specifies whether to hide a field.
      • inputType

        public final FieldInputConfig inputType()

        Describes the configuration for the default input value to display for a field.

        Returns:
        Describes the configuration for the default input value to display for a field.
      • hasValidations

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

        public final List<FieldValidationConfiguration> validations()

        The validations to perform on the value in the 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 hasValidations() method.

        Returns:
        The validations to perform on the value in the field.
      • 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)