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

Interface CtxApiOpExt

@Immutable public interface CtxApiOpExt
Extended template data for an API operation.

  • Method Summary

    Modifier and Type
    Method
    Description
    static dk.mada.jaxrs.generator.mpclient.api.tmpl.ImmutableCtxApiOpExt.Builder
    builder()
    Returns a builder for this type.
    Optional<String>
    consumes()
    Returns the optional @Consumes value for the operation.
    boolean
    hasResponses()
    Returns true if the operation has any responses, otherwise false.
    Optional<String>
    produces()
    Returns the optional @Produces value for the operation.
    boolean
    renderJavadocMacroSpacer()
    Returns true if a spacer is needed before javadoc macros.
    boolean
    renderJavadocReturn()
    Returns true if the javadoc @return statement should be rendered.
    boolean
    responseSchema()
    Use simpler @APIResponseSchema instead of @APIResponses+@APIResponse.
    Optional<String>
    summaryString()
    Returns an optional summary as a java string.

  • Method Details

    • builder

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

    • renderJavadocMacroSpacer

      boolean renderJavadocMacroSpacer()
      Returns true if a spacer is needed before javadoc macros.
      Returns:
      true if a spacer is needed before javadoc macros

    • renderJavadocReturn

      boolean renderJavadocReturn()
      Returns true if the javadoc @return statement should be rendered.
      Returns:
      true if the javadoc @return statement should be rendered

    • produces

      Optional<String> produces()
      Returns the optional @Produces value for the operation.
      Returns:
      the optional @Produces value for the operation

    • consumes

      Optional<String> consumes()
      Returns the optional @Consumes value for the operation.
      Returns:
      the optional @Consumes value for the operation

    • responseSchema

      boolean responseSchema()
      Use simpler @APIResponseSchema instead of @APIResponses+@APIResponse. Only possible for simple classes (not containers).
      Returns:
      true if the shorter ApiResponseSchema annotation should be used

    • hasResponses

      boolean hasResponses()
      Returns true if the operation has any responses, otherwise false.
      Returns:
      true if the operation has any responses, otherwise false

    • summaryString

      Optional<String> summaryString()
      Returns an optional summary as a java string.
      Returns:
      an optional summary as a java string