Package dk.mada.jaxrs.model.api

Interface Response

@Immutable public interface Response
Models the response for a resource call.

  • Method Summary

    Modifier and Type
    Method
    Description
    static dk.mada.jaxrs.model.api.ImmutableResponse.Builder
    builder()
    Returns a builder for this type.
    StatusCode
    code()
    Returns the status code of this response.
    Content
    content()
    Returns the content of this response.
    Optional<String>
    description()
    Returns an optional description of this response.
    default boolean
    isVoid()
    Returns true if this is a void-response.

  • Method Details

    • builder

      static dk.mada.jaxrs.model.api.ImmutableResponse.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • code

      StatusCode code()
      Returns the status code of this response.
      Returns:
      the status code of this response

    • content

      Content content()
      Returns the content of this response.
      Returns:
      the content of this response

    • description

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

    • isVoid

      default boolean isVoid()
      Returns true if this is a void-response.
      Returns:
      true if this is a void-response