Package org.eclipse.microprofile.openapi.models.media

Interface MediaType

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      MediaType addEncoding​(java.lang.String key, Encoding encodingItem)
      Adds an Encoding item to the encoding property of a MediaType instance.
      MediaType addExample​(java.lang.String key, Example example)
      Adds an example item to the examples map of a MediaType instance.
      default MediaType encoding​(java.util.Map<java.lang.String,​Encoding> encoding)
      Sets encoding property of a MediaType instance to the given map object.
      default MediaType example​(java.lang.Object example)
      Sets the example property of a MediaType instance to the given value.
      default MediaType examples​(java.util.Map<java.lang.String,​Example> examples)
      Sets the examples field of a MediaType instance to the given map object.
      java.util.Map<java.lang.String,​Encoding> getEncoding()
      Returns the encoding property from a MediaType instance.
      java.lang.Object getExample()
      Returns the example property from a MediaType instance.
      java.util.Map<java.lang.String,​Example> getExamples()
      Returns the collection of examples from a MediaType instance.
      Schema getSchema()
      Returns the schema property from a MediaType instance.
      void removeEncoding​(java.lang.String key)
      Removes an Encoding item to the encoding property of a MediaType instance.
      void removeExample​(java.lang.String key)
      Removes an example item to the examples map of a MediaType instance.
      default MediaType schema​(Schema schema)
      Sets the schema field of a MediaType instance to the given schema object.
      void setEncoding​(java.util.Map<java.lang.String,​Encoding> encoding)
      Sets encoding property of a MediaType instance to the given map object.
      void setExample​(java.lang.Object example)
      Sets the example property of a MediaType instance to the given value.
      void setExamples​(java.util.Map<java.lang.String,​Example> examples)
      Sets the examples field of a MediaType instance to the given map object.
      void setSchema​(Schema schema)
      Sets the schema field of a MediaType instance to the given schema object.

    • Method Detail

      • getSchema

        Schema getSchema()
        Returns the schema property from a MediaType instance.
        Returns:
        the schema defining the type used for the request body

      • setSchema

        void setSchema​(Schema schema)
        Sets the schema field of a MediaType instance to the given schema object.
        Parameters:
        schema - the schema defining the type used for the request body

      • schema

        default MediaType schema​(Schema schema)
        Sets the schema field of a MediaType instance to the given schema object.
        Parameters:
        schema - the schema defining the type used for the request body
        Returns:
        the current MediaType instance

      • getExamples

        java.util.Map<java.lang.String,​Example> getExamples()
        Returns the collection of examples from a MediaType instance.
        Returns:
        examples of the media type

      • setExamples

        void setExamples​(java.util.Map<java.lang.String,​Example> examples)
        Sets the examples field of a MediaType instance to the given map object. Each example object should match the media type and specified schema if present. The example object is mutually exclusive of the examples object.
        Parameters:
        examples - examples of the media type

      • examples

        default MediaType examples​(java.util.Map<java.lang.String,​Example> examples)
        Sets the examples field of a MediaType instance to the given map object. Each example object should match the media type and specified schema if present. The example object is mutually exclusive of the examples object.
        Parameters:
        examples - examples of the media type
        Returns:
        the current MediaType instance

      • addExample

        MediaType addExample​(java.lang.String key,
                     Example example)
        Adds an example item to the examples map of a MediaType instance. The example object should match the media type and specified schema if present.
        Parameters:
        key - any unique name to identify the example object
        example - an example of a media type. null values will be rejected (implementation will throw an exception) or ignored.
        Returns:
        the current MediaType instance

      • removeExample

        void removeExample​(java.lang.String key)
        Removes an example item to the examples map of a MediaType instance. The example object should match the media type and specified schema if present.
        Parameters:
        key - any unique name to identify the example object

      • getExample

        java.lang.Object getExample()
        Returns the example property from a MediaType instance.
        Returns:
        an example of the media type

      • setExample

        void setExample​(java.lang.Object example)
        Sets the example property of a MediaType instance to the given value. The example object should be in the correct format as specified by the media type. The example object is mutually exclusive of the examples object.
        Parameters:
        example - an example of the media type

      • example

        default MediaType example​(java.lang.Object example)
        Sets the example property of a MediaType instance to the given value. The example object should be in the correct format as specified by the media type. The example object is mutually exclusive of the examples object.
        Parameters:
        example - an example of the media type
        Returns:
        the current MediaType instance

      • getEncoding

        java.util.Map<java.lang.String,​Encoding> getEncoding()
        Returns the encoding property from a MediaType instance.
        Returns:
        a map between a property name and its encoding information

      • setEncoding

        void setEncoding​(java.util.Map<java.lang.String,​Encoding> encoding)
        Sets encoding property of a MediaType instance to the given map object.
        Parameters:
        encoding - a map between property names and their encoding information

      • encoding

        default MediaType encoding​(java.util.Map<java.lang.String,​Encoding> encoding)
        Sets encoding property of a MediaType instance to the given map object.
        Parameters:
        encoding - a map between property names and their encoding information
        Returns:
        the current MediaType instance

      • addEncoding

        MediaType addEncoding​(java.lang.String key,
                      Encoding encodingItem)
        Adds an Encoding item to the encoding property of a MediaType instance.
        Parameters:
        key - a property name in the schema
        encodingItem - an encoding definition to apply to the schema property. null values will be rejected (implementation will throw an exception) or ignored.
        Returns:
        the current MediaType instance

      • removeEncoding

        void removeEncoding​(java.lang.String key)
        Removes an Encoding item to the encoding property of a MediaType instance.
        Parameters:
        key - a property name in the schema