| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Content</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/microprofile-favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Content"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":18,"i2":6,"i3":18,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/media/Content.html" target="_top">Frames</a></li> |
| <li><a href="Content.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.microprofile.openapi.models.media</div> |
| <h2 title="Interface Content" class="title">Interface Content</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Content</span> |
| extends <a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a></pre> |
| <div class="block">Content |
| <p> |
| A map to assist describing the media types for an operation's parameter or response.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html#addMediaType-java.lang.String-org.eclipse.microprofile.openapi.models.media.MediaType-">addMediaType</a></span>(java.lang.String name, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> mediaType)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html#getMediaType-java.lang.String-">getMediaType</a></span>(java.lang.String name)</code> |
| <div class="block">Returns a media type for a given name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html#getMediaTypes--">getMediaTypes</a></span>()</code> |
| <div class="block">Returns a copy map (potentially immutable) of media types.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html#hasMediaType-java.lang.String-">hasMediaType</a></span>(java.lang.String name)</code> |
| <div class="block">Check whether a media type is present in the map.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html#removeMediaType-java.lang.String-">removeMediaType</a></span>(java.lang.String name)</code> |
| <div class="block">Removes the given MediaType for this Content by its name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html#setMediaTypes-java.util.Map-">setMediaTypes</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a>> mediaTypes)</code> |
| <div class="block">Set the media types map to this Content</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addMediaType-java.lang.String-org.eclipse.microprofile.openapi.models.media.MediaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMediaType</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a> addMediaType(java.lang.String name, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> mediaType)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of a media type e.g. application/json.</dd> |
| <dd><code>mediaType</code> - 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.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Content instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeMediaType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMediaType</h4> |
| <pre>void removeMediaType(java.lang.String name)</pre> |
| <div class="block">Removes the given MediaType for this Content by its name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a path name that will be removed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMediaTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMediaTypes</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a>> getMediaTypes()</pre> |
| <div class="block">Returns a copy map (potentially immutable) of media types.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all items</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMediaTypes-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMediaTypes</h4> |
| <pre>void setMediaTypes(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a>> mediaTypes)</pre> |
| <div class="block">Set the media types map to this Content</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mediaTypes</code> - a map containing the list of media types. Keys are name of a media type e.g. application/json.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasMediaType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasMediaType</h4> |
| <pre>default boolean hasMediaType(java.lang.String name)</pre> |
| <div class="block">Check whether a media type is present in the map. This is a convenience method for |
| <code>getMediaTypes().containsKey(name)</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of a media type e.g. application/json.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean to indicate if the media type is present or not.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMediaType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMediaType</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> getMediaType(java.lang.String name)</pre> |
| <div class="block">Returns a media type for a given name. This is a convenience method for <code>getMediaTypes().get(name)</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of a media type e.g. application/json.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding media type or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/media/Content.html" target="_top">Frames</a></li> |
| <li><a href="Content.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
