Package com.adobe.granite.haf.converter.api.description

Interface ActionFieldDescription

@ProviderType public interface ActionFieldDescription
A description of a field that an action is expecting.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Get the name of the field.
    String
    getType()
    Get the type of the field.
    Object
    getValue()
    Get the value of the field.
    boolean
    isMulti()
    Get whether the field can support multiple values.
    boolean
    isOptional()
    Get whether the field is optional or not.

  • Method Details

    • getName

      @Nonnull String getName()
      Get the name of the field.
      Returns:
      The name.

    • getType

      @CheckForNull String getType()
      Get the type of the field.
      Returns:
      The type.

    • getValue

      @CheckForNull Object getValue()
      Get the value of the field.
      Returns:
      The value.

    • isOptional

      boolean isOptional()
      Get whether the field is optional or not.
      Returns:
      Whether the field is optional or not.

    • isMulti

      boolean isMulti()
      Get whether the field can support multiple values.
      Returns:
      Whether the field can support multiple values.