| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Encoding</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="Encoding"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":18,"i2":18,"i3":18,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":18,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":18}; |
| 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><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum 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/Encoding.html" target="_top">Frames</a></li> |
| <li><a href="Encoding.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><a href="#nested.class.summary">Nested</a> | </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 Encoding" class="title">Interface Encoding</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><<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Encoding</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><<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>></pre> |
| <div class="block">Encoding</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.md#encodingObject">Encoding Object</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media">Encoding.Style</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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/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/Encoding.html#addHeader-java.lang.String-org.eclipse.microprofile.openapi.models.headers.Header-">addHeader</a></span>(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</code> |
| <div class="block">Adds the given header to this Encoding' list of headers with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default <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/Encoding.html#allowReserved-java.lang.Boolean-">allowReserved</a></span>(java.lang.Boolean allowReserved)</code> |
| <div class="block">AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default <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/Encoding.html#contentType-java.lang.String-">contentType</a></span>(java.lang.String contentType)</code> |
| <div class="block">The Content-Type for encoding a specific property.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <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/Encoding.html#explode-java.lang.Boolean-">explode</a></span>(java.lang.Boolean explode)</code> |
| <div class="block">When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the |
| map.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html#getAllowReserved--">getAllowReserved</a></span>()</code> |
| <div class="block">AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html#getContentType--">getContentType</a></span>()</code> |
| <div class="block">The Content-Type for encoding a specific property.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html#getExplode--">getExplode</a></span>()</code> |
| <div class="block">When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the |
| map.</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/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html#getHeaders--">getHeaders</a></span>()</code> |
| <div class="block">Headers property of an Encoding is a map that allows additional information to be provided as headers</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media">Encoding.Style</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html#getStyle--">getStyle</a></span>()</code> |
| <div class="block">Style describes how the encoding value will be serialized depending on the type of the parameter value.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>default <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/Encoding.html#headers-java.util.Map-">headers</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</code> |
| <div class="block">Headers property of an Encoding is a map that allows additional information to be provided as headers</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/Encoding.html#removeHeader-java.lang.String-">removeHeader</a></span>(java.lang.String key)</code> |
| <div class="block">Removes the given header to this Encoding' list of headers with the given string as its key.</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/Encoding.html#setAllowReserved-java.lang.Boolean-">setAllowReserved</a></span>(java.lang.Boolean allowReserved)</code> |
| <div class="block">AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.</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/Encoding.html#setContentType-java.lang.String-">setContentType</a></span>(java.lang.String contentType)</code> |
| <div class="block">The Content-Type for encoding a specific property.</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/Encoding.html#setExplode-java.lang.Boolean-">setExplode</a></span>(java.lang.Boolean explode)</code> |
| <div class="block">When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the |
| map.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html#setHeaders-java.util.Map-">setHeaders</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</code> |
| <div class="block">Headers property of an Encoding is a map that allows additional information to be provided as headers</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html#setStyle-org.eclipse.microprofile.openapi.models.media.Encoding.Style-">setStyle</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media">Encoding.Style</a> style)</code> |
| <div class="block">Style describes how the encoding value will be serialized depending on the type of the parameter value.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>default <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/Encoding.html#style-org.eclipse.microprofile.openapi.models.media.Encoding.Style-">style</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media">Encoding.Style</a> style)</code> |
| <div class="block">Style describes how the encoding value will be serialized depending on the type of the parameter value.</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#extensions-java.util.Map-">extensions</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#getExtensions--">getExtensions</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#removeExtension-java.lang.String-">removeExtension</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="contentType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contentType</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> contentType(java.lang.String contentType)</pre> |
| <div class="block">The Content-Type for encoding a specific property. Default value depends on the property type: i.e. for binary string - contentType is |
| application/octet-stream, for primitive types - text/plain, for object - application/json. |
| <p> |
| This method sets contentType property for the Encoding instance to the passed parameter and returns the modified instance |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentType</code> - a string that describes the type of content of the encoding</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Encoding</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentType</h4> |
| <pre>java.lang.String getContentType()</pre> |
| <div class="block">The Content-Type for encoding a specific property. Default value depends on the property type: i.e. for binary string - contentType is |
| application/octet-stream, for primitive types - text/plain, for object - application/json. |
| <p> |
| This method returns the contentType property from an Encoding instance. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String contentType</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContentType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentType</h4> |
| <pre>void setContentType(java.lang.String contentType)</pre> |
| <div class="block">The Content-Type for encoding a specific property. Default value depends on the property type: i.e. for binary string - contentType is |
| application/octet-stream, for primitive types - text/plain, for object - application/json. |
| <p> |
| This method sets thecontentType property of an Encoding instance to the passed contentType parameter. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentType</code> - a string that describes the type of content of the encoding</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="headers-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headers</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> headers(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</pre> |
| <div class="block">Headers property of an Encoding is a map that allows additional information to be provided as headers |
| <p> |
| This method sets the headers property of Encoding instance to the passed headers argument and returns the modified instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - a map of name to corresponding header object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Encoding</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> getHeaders()</pre> |
| <div class="block">Headers property of an Encoding is a map that allows additional information to be provided as headers |
| <p> |
| This method returns the headers property from a Encoding instance. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy Map (potentially immutable) containing headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeaders-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeaders</h4> |
| <pre>void setHeaders(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</pre> |
| <div class="block">Headers property of an Encoding is a map that allows additional information to be provided as headers |
| <p> |
| This method sets the headers property of Encoding instance to the passed headers argument. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - a map of name to corresponding header object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addHeader-java.lang.String-org.eclipse.microprofile.openapi.models.headers.Header-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeader</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> addHeader(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</pre> |
| <div class="block">Adds the given header to this Encoding' list of headers with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>header</code> - the header object. null values will be rejected (implementation will throw an exception) or ignored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Encoding object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeHeader</h4> |
| <pre>void removeHeader(java.lang.String key)</pre> |
| <div class="block">Removes the given header to this Encoding' list of headers with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="style-org.eclipse.microprofile.openapi.models.media.Encoding.Style-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>style</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> style(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media">Encoding.Style</a> style)</pre> |
| <div class="block">Style describes how the encoding value will be serialized depending on the type of the parameter value. |
| <p> |
| This method sets the style property of Encoding instance to the passed style argument and returns the modified instance |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>style</code> - a string that descibes how encoding value will be serialized</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Encoding</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStyle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStyle</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media">Encoding.Style</a> getStyle()</pre> |
| <div class="block">Style describes how the encoding value will be serialized depending on the type of the parameter value. |
| <p> |
| This method returns the style property from a Encoding instance. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String style</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStyle-org.eclipse.microprofile.openapi.models.media.Encoding.Style-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyle</h4> |
| <pre>void setStyle(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum in org.eclipse.microprofile.openapi.models.media">Encoding.Style</a> style)</pre> |
| <div class="block">Style describes how the encoding value will be serialized depending on the type of the parameter value. |
| <p> |
| This method sets the style property of Encoding instance to the given style argument. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>style</code> - a string that descibes how encoding value will be serialized</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="explode-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>explode</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> explode(java.lang.Boolean explode)</pre> |
| <div class="block">When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the |
| map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the |
| default value is false. |
| <p> |
| This method sets the explode property of Encoding instance to the given explode argument and returns the instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>explode</code> - a boolean that indicates whether the property values of array or object will generate separate parameters</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Encoding</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExplode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExplode</h4> |
| <pre>java.lang.Boolean getExplode()</pre> |
| <div class="block">When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the |
| map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the |
| default value is false. |
| <p> |
| This method returns the explode property from a Encoding instance. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean explode</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExplode-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExplode</h4> |
| <pre>void setExplode(java.lang.Boolean explode)</pre> |
| <div class="block">When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the |
| map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the |
| default value is false. |
| <p> |
| This method sets the explode property of Encoding instance to the given explode argument. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>explode</code> - a boolean that indicates whether the property values of array or object will generate separate parameters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allowReserved-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allowReserved</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a> allowReserved(java.lang.Boolean allowReserved)</pre> |
| <div class="block">AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding. |
| <p> |
| This method sets the allowReserved property of Encoding instance to the given allowReserved argument and returns the instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allowReserved</code> - a boolean that determines whether the parameter value SHOULD allow reserved characters</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Encoding</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllowReserved--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllowReserved</h4> |
| <pre>java.lang.Boolean getAllowReserved()</pre> |
| <div class="block">AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding. |
| <p> |
| This method returns the allowReserved property from a Encoding instance. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean allowReserved</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAllowReserved-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setAllowReserved</h4> |
| <pre>void setAllowReserved(java.lang.Boolean allowReserved)</pre> |
| <div class="block">AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding. |
| <p> |
| This method sets the allowReserved property to the given allowReserved argument. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allowReserved</code> - a boolean that determines whether the parameter value SHOULD allow reserved characters</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/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.Style.html" title="enum 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/Encoding.html" target="_top">Frames</a></li> |
| <li><a href="Encoding.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><a href="#nested.class.summary">Nested</a> | </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> |