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

Interface Content

  • All Superinterfaces:
    Constructible, java.util.Map<java.lang.String,MediaType>

    public interface Content
extends Constructible, java.util.Map<java.lang.String,MediaType>
    Content

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

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Content addMediaType​(java.lang.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.

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

    • Method Detail

      • addMediaType

        Content addMediaType​(java.lang.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.
        Returns:
        the current Content instance