Package org.apache.juneau.dto.openapi3

Class Encoding

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

  • Constructor Details

    • Encoding

      public Encoding()
      Default constructor.

    • Encoding

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

  • Method Details

    • copy

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

    • strict

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

    • getContentType

      public String getContentType()
      Bean property getter: contentType.

      The URL pointing to the contact information.

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

    • setContentType

      public Encoding setContentType(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

    • getStyle

      public String getStyle()
      Bean property getter: style.
      Returns:
      The property value, or null if it is not set.

    • setStyle

      public Encoding setStyle(String value)
      Bean property setter: description.
      Parameters:
      value - The new value for this property.
      Returns:
      This object

    • getHeaders

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

    • setHeaders

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

    • addHeader

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

    • getExplode

      public Boolean getExplode()
      Bean property getter: required.

      The type of the object.

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

    • setExplode

      public Encoding setExplode(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

  • getAllowReserved

    public Boolean getAllowReserved()
    Bean property getter: required.

    The type of the object.

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

  • setAllowReserved

    public Encoding setAllowReserved(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 Encoding 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.