Package org.apache.juneau.dto.openapi3

Class MediaType

java.lang.Object
org.apache.juneau.dto.openapi3.OpenApiElement
org.apache.juneau.dto.openapi3.MediaType
@Bean(properties="schema,example,examples,encoding,*") public class MediaType extends OpenApiElement
TODO

  • Constructor Details

    • MediaType

      public MediaType()
      Default constructor.

    • MediaType

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

  • Method Details

    • copy

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

    • strict

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

    • getSchema

      public SchemaInfo getSchema()
      Bean property getter: schema.
      Returns:
      The property value, or null if it is not set.

    • setSchema

      public MediaType setSchema(SchemaInfo value)
      Bean property setter: schema.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getExample

      @Beanp("x-example") public Object getExample()
      Bean property getter: x-example.
      Returns:
      The property value, or null if it is not set.

    • setExample

      @Beanp("x-example") public MediaType setExample(Object value)
      Bean property setter: examples.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getEncoding

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

    • setEncoding

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

    • addEncoding

      public MediaType addEncoding(String key, Encoding 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

    • getExamples

      public Map<String,Example> getExamples()
      Bean property getter: examples.

      The list of possible responses as they are returned from executing this operation.

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

    • setExamples

      public MediaType setExamples(Map<String,Example> value)
      Bean property setter: headers.

      A list of examples that are sent with the response.

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

    • addExample

      public MediaType addExample(String name, Example example)
      Adds a single value to the examples property.
      Parameters:
      name - The example name.
      example - The example.
      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 MediaType 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.