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

Interface Content

All Superinterfaces:
Constructible, Map<String,MediaType>
public interface Content extends Constructible, Map<String,MediaType>
Content

A map to assist describing the media types for an operation's parameter or response.

  • Method Details

    • addMediaType

      Content addMediaType(String name, MediaType mediaType)
      Adds the MediaType for this Content, where the key is the name of the MediaType and the value is the object that describes the content passed into or returned from an operation.
      Parameters:
      name - the name of a media type e.g. application/json.
      mediaType - an object that describes the content passed into or returned from an operation. null values will be rejected (implementation will throw an exception) or ignored.
      Returns:
      the current Content instance

    • removeMediaType

      void removeMediaType(String name)
      Removes the given MediaType for this Content by its name.
      Parameters:
      name - a path name that will be removed.

    • getMediaTypes

      Map<String,MediaType> getMediaTypes()
      Returns a copy map (potentially immutable) of media types.
      Returns:
      all items

    • setMediaTypes

      void setMediaTypes(Map<String,MediaType> mediaTypes)
      Set the media types map to this Content
      Parameters:
      mediaTypes - a map containing the list of media types. Keys are name of a media type e.g. application/json.

    • hasMediaType

      default boolean hasMediaType(String name)
      Check whether a media type is present in the map. This is a convenience method for getMediaTypes().containsKey(name)
      Parameters:
      name - the name of a media type e.g. application/json.
      Returns:
      a boolean to indicate if the media type is present or not.

    • getMediaType

      default MediaType getMediaType(String name)
      Returns a media type for a given name. This is a convenience method for getMediaTypes().get(name)
      Parameters:
      name - the name of a media type e.g. application/json.
      Returns:
      the corresponding media type or null.

    • get

      @Deprecated MediaType get(Object key)
      Deprecated.
      since 1.1
      In the next version, Content will no longer extends Map, this method will no longer be present. Use getMediaType(String) instead.
      Specified by:
      get in interface Map<String,MediaType>

    • containsKey

      @Deprecated boolean containsKey(Object key)
      Deprecated.
      since 1.1
      In the next version, Content will no longer extends Map, this method will no longer be present. Use hasMediaType(String) instead.
      Specified by:
      containsKey in interface Map<String,MediaType>

    • put

      @Deprecated MediaType put(String key, MediaType value)
      Deprecated.
      since 1.1
      In the next version, Content will no longer extends Map, this method will no longer be present. Use addMediaType(String, MediaType) instead.
      Specified by:
      put in interface Map<String,MediaType>

    • putAll

      @Deprecated void putAll(Map<? extends String,? extends MediaType> m)
      Deprecated.
      since 1.1
      In the next version, Content will no longer extends Map, this method will no longer be present. Use setMediaTypes(Map) instead.
      Specified by:
      putAll in interface Map<String,MediaType>

    • remove

      @Deprecated MediaType remove(Object key)
      Deprecated.
      since 1.1
      In the next version, Content will no longer extends Map, this method will no longer be present. Use removeMediaType(String) instead.
      Specified by:
      remove in interface Map<String,MediaType>