Package dk.mada.jaxrs.generator.mpclient.api.tmpl

Interface CtxApiParam

All Known Implementing Classes:
ImmutableCtxApiParam
@Immutable public interface CtxApiParam
Template data for an API operation parameter.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    baseName()
    Returns base name of a path parameter.
    static ImmutableCtxApiParam.Builder
    builder()
    Returns a builder for this type.
    String
    dataType()
    Returns the java type of the parameter.
    Optional<String>
    defaultValue()
    Returns an optional default value for the parameter.
    Optional<String>
    description()
    Returns an optional description of the parameter.
    boolean
    isBodyParam()
    Returns true if this is the body parameter, otherwise false.
    boolean
    isContainer()
    Returns true if the parameter is a container.
    boolean
    isFormParam()
    Returns true if this is a form parameter, otherwise false.
    boolean
    isHeaderParam()
    Returns true if this is a header parameter, otherwise false.
    boolean
    isMultipartForm()
    Returns true if this is a multipart form body, otherwise false.
    boolean
    isNullable()
    Returns true if this parameter is nullable.
    boolean
    isPathParam()
    Returns true if this is a path parameter, otherwise false.
    boolean
    isQueryParam()
    Returns true if this is a query parameter, otherwise false.
    String
    paramName()
    Returns the name given to the parameter in the function.
    Optional<CtxValidation>
    validation()
    Returns context for bean validation if relevant for this parameter.

  • Method Details

    • builder

      static ImmutableCtxApiParam.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • isContainer

      boolean isContainer()
      Returns true if the parameter is a container.
      Returns:
      true if the parameter is a container

    • description

      Optional<String> description()
      Returns an optional description of the parameter.
      Returns:
      an optional description of the parameter

    • defaultValue

      Optional<String> defaultValue()
      Returns an optional default value for the parameter.
      Returns:
      an optional default value for the parameter

    • baseName

      String baseName()
      Returns base name of a path parameter.
      Returns:
      base name of a path parameter

    • paramName

      String paramName()
      Returns the name given to the parameter in the function.
      Returns:
      the name given to the parameter in the function

    • dataType

      String dataType()
      Returns the java type of the parameter.
      Returns:
      the java type of the parameter

    • isBodyParam

      boolean isBodyParam()
      Returns true if this is the body parameter, otherwise false.
      Returns:
      true if this is the body parameter, otherwise false

    • isHeaderParam

      boolean isHeaderParam()
      Returns true if this is a header parameter, otherwise false.
      Returns:
      true if this is a header parameter, otherwise false

    • isPathParam

      boolean isPathParam()
      Returns true if this is a path parameter, otherwise false.
      Returns:
      true if this is a path parameter, otherwise false

    • isQueryParam

      boolean isQueryParam()
      Returns true if this is a query parameter, otherwise false.
      Returns:
      true if this is a query parameter, otherwise false

    • isFormParam

      boolean isFormParam()
      Returns true if this is a form parameter, otherwise false.
      Returns:
      true if this is a form parameter, otherwise false

    • validation

      Optional<CtxValidation> validation()
      Returns context for bean validation if relevant for this parameter.
      Returns:
      context for bean validation if relevant for this parameter

    • isMultipartForm

      boolean isMultipartForm()
      Returns true if this is a multipart form body, otherwise false.
      Returns:
      true if this is a multipart form body, otherwise false

    • isNullable

      boolean isNullable()
      Returns true if this parameter is nullable.
      Returns:
      true if this parameter is nullable