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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Get the name of the field.
      java.lang.String getType()
      Get the type of the field.
      java.lang.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 Detail

      • getName

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

      • getType

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

      • getValue

        @CheckForNull
java.lang.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.