Package com.commercetools.api.models.type

Interface TypeTextInputHint

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
TypeTextInputHint.TypeTextInputHintEnum
public interface TypeTextInputHint extends JsonEnum

Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType. Following values are supported:

  • Field Details

    • SINGLE_LINE

      static final TypeTextInputHint SINGLE_LINE

      Hint for GUIs to display the field's content in a single line of text.

    • MULTI_LINE

      static final TypeTextInputHint MULTI_LINE

      Hint for GUIs to display the field's content over multiple lines of text.

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static TypeTextInputHint findEnum(String value)
      factory method for a enum value of TypeTextInputHint if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<TypeTextInputHint> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static TypeTextInputHint[] values()
      possible enum values
      Returns:
      array of possible enum values