Package org.mule.apikit.model.parameter

Interface Parameter

public interface Parameter

  • Method Details

    • isRequired

      boolean isRequired()

    • getDefaultValue

      @Deprecated String getDefaultValue()
      Deprecated.
      Please use getDefaultValues() instead
      Returns:
      default value as string if any, otherwise null

    • getDefaultValues

      List<String> getDefaultValues()
      Returns:
      a list of default values. Empty list if no default was found.
      Since:
      2.5.3

    • isRepeat

      boolean isRepeat()

    • isArray

      boolean isArray()

    • validate

      boolean validate(String value)

    • validateArray

      boolean validateArray(Collection<?> values)

    • message

      String message(String value)

    • messageFromValues

      String messageFromValues(Collection<?> values)

    • getDisplayName

      String getDisplayName()

    • getDescription

      String getDescription()

    • getExample

      String getExample()

    • getExamples

      Map<String,String> getExamples()

    • getInstance

      Object getInstance()

    • getMetadata

      org.mule.metadata.api.model.MetadataType getMetadata()

    • isScalar

      @Deprecated boolean isScalar()
      Deprecated.

    • isFacetArray

      @Deprecated boolean isFacetArray(String facet)
      Deprecated.

    • surroundWithQuotesIfNeeded

      String surroundWithQuotesIfNeeded(String value)

    • getFileProperties

      Optional<FileProperties> getFileProperties()

    • isNullable

      boolean isNullable()
      Determines if the parameter allows null values.
      Since:
      2.4.0

    • getMaxItems

      default Optional<Integer> getMaxItems()

    • getMinItems

      default Optional<Integer> getMinItems()

    • isExplode

      default boolean isExplode()
      Determines whether the parameter uses exploded serialization. When false and the parameter is an array, values are comma-separated in a single entry (e.g., ?types=INVOICE,CREDIT_NOTE) and must be split before validation.
      Returns:
      true if explode is enabled (default per OAS 3.0 for style=form), false otherwise
      Since:
      3.0.0

    • getStyle

      default String getStyle()

    • isAllowReserved

      default boolean isAllowReserved()
      Whether reserved characters (per RFC 3986) should be allowed without percent-encoding. Only applicable to query parameters. When true, values like ?color=blue%2Fgreen are sent as ?color=blue/green without encoding.
      Returns:
      true if reserved characters are allowed unencoded, false otherwise (default)
      Since:
      3.0.0

    • isAllowEmptyValue

      default boolean isAllowEmptyValue()
      Whether an empty value is permitted for this parameter. When true, ?param= (empty string) is valid.
      Returns:
      true if empty values are allowed, false otherwise (default)
      Since:
      3.0.0