Package org.apache.juneau.dto.openapi3

Class RequestBodyInfo

java.lang.Object
org.apache.juneau.dto.openapi3.OpenApiElement
org.apache.juneau.dto.openapi3.RequestBodyInfo
@Bean(properties="description,content,required,*") public class RequestBodyInfo extends OpenApiElement
TODO

  • Constructor Details

  • Method Details

    • copy

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

    • strict

      protected RequestBodyInfo 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: contentType.

      The URL pointing to the contact information.

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

    • setDescription

      public RequestBodyInfo setDescription(String value)
      Bean property setter: url.

      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

    • getContent

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

    • setContent

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

    • addContent

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

    • getRequired

      public Boolean getRequired()
      Bean property getter: required.

      The type of the object.

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

    • setRequired

      public RequestBodyInfo setRequired(Boolean value)
      Bean property setter: explode.

      The type of the object.

      Parameters:
      value - The new value for this property.
      Property value is required.
    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 RequestBodyInfo 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.