Package org.apache.juneau.dto.openapi3

Class Response

java.lang.Object
org.apache.juneau.dto.openapi3.OpenApiElement
org.apache.juneau.dto.openapi3.Response
@Bean(properties="contentType,style,explode,headers,allowReserved,*") public class Response extends OpenApiElement
TODO

  • Constructor Details

    • Response

      public Response()
      Default constructor.

    • Response

      public Response(Response copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The object to copy.

  • Method Details

    • copy

      public Response copy()
      Make a deep copy of this object.
      Returns:
      A deep copy of this object.

    • strict

      protected Response strict()
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Returns:
      This object

    • getDescription

      public String getDescription()
      Bean property getter: Description.

      The URL pointing to the contact information.

      Returns:
      The property value, or null if it is not set.

    • setDescription

      public Response setDescription(String value)
      Bean property setter: Description.

      The value can be of any of the following types: URI, URL, String.
      Strings must be valid URIs.

      URIs defined by UriResolver can be used for values.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getHeaders

      public Map<String,HeaderInfo> getHeaders()
      Bean property getter: headers.
      Returns:
      The property value, or null if it is not set.

    • setHeaders

      public Response setHeaders(Map<String,HeaderInfo> value)
      Bean property setter: headers.
      Parameters:
      value - The new value for this property.
      Returns:
      This object

    • addHeader

      public Response addHeader(String key, HeaderInfo value)
      Adds one or more values to the variables property.
      Parameters:
      key - The mapping key.
      value - The values to add to this property.
      Ignored if null.
      Returns:
      This object

    • getContent

      public Map<String,MediaType> getContent()
      Bean property getter: headers.
      Returns:
      The property value, or null if it is not set.

    • setContent

      public Response setContent(Map<String,MediaType> value)
      Bean property setter: content.
      Parameters:
      value - The new value for this property.
      Returns:
      This object

    • addContent

      public Response addContent(String key, MediaType value)
      Adds one or more values to the variables property.
      Parameters:
      key - The mapping key.
      value - The values to add to this property.
      Ignored if null.
      Returns:
      This object

    • getLinks

      public Map<String,Link> getLinks()
      Bean property getter: link.
      Returns:
      The property value, or null if it is not set.

    • setLinks

      public Response setLinks(Map<String,Link> value)
      Bean property setter: Link.
      Parameters:
      value - The new value for this property.
      Returns:
      This object

    • addLink

      public Response addLink(String key, Link value)
      Adds one or more values to the variables property.
      Parameters:
      key - The mapping key.
      value - The values to add to this property.
      Ignored if null.
      Returns:
      This object

    • get

      public <T> T get(String property, Class<T> type)
      Description copied from class: OpenApiElement
      Generic property getter.

      Can be used to retrieve non-standard Swagger fields such as "$ref".

      Overrides:
      get in class OpenApiElement
      Type Parameters:
      T - The datatype to cast the value to.
      Parameters:
      property - The property name to retrieve.
      type - The datatype to cast the value to.
      Returns:
      The property value, or null if the property does not exist or is not set.

    • set

      public Response set(String property, Object value)
      Description copied from class: OpenApiElement
      Generic property setter.

      Can be used to set non-standard Swagger fields such as "$ref".

      Overrides:
      set in class OpenApiElement
      Parameters:
      property - The property name to set.
      value - The new value for the property.
      Returns:
      This object

    • keySet

      public Set<String> keySet()
      Description copied from class: OpenApiElement
      Returns all the keys on this element.
      Overrides:
      keySet in class OpenApiElement
      Returns:
      All the keys on this element.
      Never null.