| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MediaType</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="MediaType"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.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/MediaType.html" target="_top">Frames</a></li> |
| <li><a href="MediaType.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 MediaType" class="title">Interface MediaType</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>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">MediaType</span> |
| extends <a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></pre> |
| <div class="block">MediaType |
| <p> |
| Each Media Type Object provides a schema and examples for the media type identified by its key. |
| <p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#mediaTypeObject">OpenAPI Specification Media Type |
| Object</a></dd> |
| </dl> |
| </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></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/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/MediaType.html#addEncoding-java.lang.String-org.eclipse.microprofile.openapi.models.media.Encoding-">addEncoding</a></span>(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> encodingItem)</code> |
| <div class="block">Adds an Encoding item to the encoding property of a MediaType instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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/MediaType.html#addExample-java.lang.String-org.eclipse.microprofile.openapi.models.examples.Example-">addExample</a></span>(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a> example)</code> |
| <div class="block">Adds an example item to the examples map of a MediaType instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><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/MediaType.html#encoding-java.util.Map-">encoding</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>> encoding)</code> |
| <div class="block">Sets encoding property of a MediaType instance to the given map object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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/MediaType.html#example-java.lang.Object-">example</a></span>(java.lang.Object example)</code> |
| <div class="block">Sets the example property of a MediaType instance to the given value.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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/MediaType.html#examples-java.util.Map-">examples</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</code> |
| <div class="block">Sets the examples field of a MediaType instance to the given map object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#getEncoding--">getEncoding</a></span>()</code> |
| <div class="block">Returns the encoding property from a MediaType instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#getExample--">getExample</a></span>()</code> |
| <div class="block">Returns the example property from a MediaType instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#getExamples--">getExamples</a></span>()</code> |
| <div class="block">Returns the collection of examples from a MediaType instance.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#getSchema--">getSchema</a></span>()</code> |
| <div class="block">Returns the schema property from a MediaType instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><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/MediaType.html#schema-org.eclipse.microprofile.openapi.models.media.Schema-">schema</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</code> |
| <div class="block">Sets the schema field of a MediaType instance to the given schema object.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#setEncoding-java.util.Map-">setEncoding</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>> encoding)</code> |
| <div class="block">Sets encoding property of a MediaType instance to the given map object.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#setExample-java.lang.Object-">setExample</a></span>(java.lang.Object example)</code> |
| <div class="block">Sets the example property of a MediaType instance to the given value.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#setExamples-java.util.Map-">setExamples</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</code> |
| <div class="block">Sets the examples field of a MediaType instance to the given map object.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html#setSchema-org.eclipse.microprofile.openapi.models.media.Schema-">setSchema</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</code> |
| <div class="block">Sets the schema field of a MediaType instance to the given schema object.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Extensible"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.microprofile.openapi.models.<a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></h3> |
| <code><a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#addExtension-java.lang.String-java.lang.Object-">addExtension</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#getExtensions--">getExtensions</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#setExtensions-java.util.Map-">setExtensions</a></code></li> |
| </ul> |
| </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="getSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> getSchema()</pre> |
| <div class="block">Returns the schema property from a MediaType instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the schema defining the type used for the request body</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSchema-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchema</h4> |
| <pre>void setSchema(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</pre> |
| <div class="block">Sets the schema field of a MediaType instance to the given schema object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - the schema defining the type used for the request body</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="schema-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> schema(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</pre> |
| <div class="block">Sets the schema field of a MediaType instance to the given schema object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - the schema defining the type used for the request body</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current MediaType instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExamples--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExamples</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> getExamples()</pre> |
| <div class="block">Returns the collection of examples from a MediaType instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>examples of the media type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExamples-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExamples</h4> |
| <pre>void setExamples(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>examples</code> - examples of the media type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="examples-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>examples</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> examples(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>examples</code> - examples of the media type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current MediaType instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addExample-java.lang.String-org.eclipse.microprofile.openapi.models.examples.Example-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExample</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> addExample(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a> example)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - any unique name to identify the example object</dd> |
| <dd><code>example</code> - an example of a media type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current MediaType instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExample--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExample</h4> |
| <pre>java.lang.Object getExample()</pre> |
| <div class="block">Returns the example property from a MediaType instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an example of the media type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExample-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExample</h4> |
| <pre>void setExample(java.lang.Object example)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>example</code> - an example of the media type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="example-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>example</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> example(java.lang.Object example)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>example</code> - an example of the media type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current MediaType instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncoding</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>> getEncoding()</pre> |
| <div class="block">Returns the encoding property from a MediaType instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map between a property name and its encoding information</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncoding-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncoding</h4> |
| <pre>void setEncoding(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>> encoding)</pre> |
| <div class="block">Sets encoding property of a MediaType instance to the given map object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoding</code> - a map between property names and their encoding information</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encoding-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encoding</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> encoding(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>> encoding)</pre> |
| <div class="block">Sets encoding property of a MediaType instance to the given map object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoding</code> - a map between property names and their encoding information</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current MediaType instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addEncoding-java.lang.String-org.eclipse.microprofile.openapi.models.media.Encoding-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addEncoding</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a> addEncoding(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> encodingItem)</pre> |
| <div class="block">Adds an Encoding item to the encoding property of a MediaType instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a property name in the schema</dd> |
| <dd><code>encodingItem</code> - an encoding definition to apply to the schema property.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current MediaType instance</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><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.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/MediaType.html" target="_top">Frames</a></li> |
| <li><a href="MediaType.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> |
