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

Interface CtxApiResponse

@Immutable public interface CtxApiResponse
Template data for an API operation response.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    baseType()
    Returns the type of this response, or null.
    static dk.mada.jaxrs.generator.mpclient.api.tmpl.ImmutableCtxApiResponse.Builder
    builder()
    Returns a builder for this type.
    String
    code()
    Returns the HTTP response of this response (or 'default').
    @Nullable String
    containerType()
    Returns the container type of this response, or null.
    Optional<String>
    description()
    Returns the optional description of this response.
    boolean
    isUnique()
    Returns true if the container is a set (array with unique elements).
    Optional<String>
    mediaType()
    Returns the media-type of this response if necessary.

  • Method Details

    • builder

      static dk.mada.jaxrs.generator.mpclient.api.tmpl.ImmutableCtxApiResponse.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • code

      String code()
      Returns the HTTP response of this response (or 'default').
      Returns:
      the HTTP response of this response (or 'default')

    • description

      Optional<String> description()
      Returns the optional description of this response.
      Returns:
      the optional description of this response

    • baseType

      @Nullable String baseType()
      Returns the type of this response, or null.
      Returns:
      the type of this response, or null

    • containerType

      @Nullable String containerType()
      Returns the container type of this response, or null.
      Returns:
      the container type of this response, or null

    • mediaType

      Optional<String> mediaType()
      Returns the media-type of this response if necessary.
      Returns:
      the media-type of this response if necessary

    • isUnique

      boolean isUnique()
      Returns true if the container is a set (array with unique elements).
      Returns:
      true if the container is a set (array with unique elements)