Google Git
Sign in
apache / tomee-site-pub / 476cf231b77b83a25b4407df84b6a5fd7c0d673a / . / microprofile-5.0 / javadoc / org / eclipse / microprofile / openapi / annotations / media / Encoding.html
blob: 526954e97a7c9797942b5fa46dda90da5d0fcb5b [file] [log] [blame]
<!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) {
}
//-->
</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/annotations/media/DiscriminatorMapping.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/ExampleObject.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/annotations/media/Encoding.html" target="_top">Frames</a></li>
<li><a href="Encoding.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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.annotations.media</div>
<h2 title="Annotation Type Encoding" class="title">Annotation Type Encoding</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Target(value={})
@Retention(value=RUNTIME)
@Inherited
public @interface <span class="memberNameLabel">Encoding</span></pre>
<div class="block">Single encoding definition to be applied to single Schema Object</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">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Encoding.html#allowReserved--">allowReserved</a></span></code>
<div class="block">Determines whether the encoding instance value SHOULD allow reserved characters, as defined by RFC3986 to be
included without percent-encoding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Encoding.html#contentType--">contentType</a></span></code>
<div class="block">The Content-Type for encoding a specific property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Encoding.html#explode--">explode</a></span></code>
<div class="block">When explode is set to 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 class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/headers/Header.html" title="annotation in org.eclipse.microprofile.openapi.annotations.headers">Header</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Encoding.html#headers--">headers</a></span></code>
<div class="block">An array of headers that corresponds to a map of headers in the encoding model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Encoding.html#name--">name</a></span></code>
<div class="block">The name of this encoding object instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Encoding.html#style--">style</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>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
<div class="block">The name of this encoding object instance. This property is a key in an encoding map of a MediaType object and
MUST exist in a schema as a property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of this encoding instance</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="contentType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentType</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;contentType</pre>
<div class="block">The Content-Type for encoding a specific property. Default value depends on the property type.
<p>
For example, for binary string - contentType is application/octet-stream, for primitive types - text/plain, for
object - application/json. The value can be a specific media type (e.g. application/json), a wildcard media type
(e.g. image/*), or a comma-separated list of the two types.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the contentType property of this encoding instance</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="style--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>style</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;style</pre>
<div class="block">Style describes how the encoding value will be serialized depending on the type of the parameter value. This
property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
<p>
Default values include: form, spaceDelimited, pipeDelimited, and deepObject.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the style of this encoding instance</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="explode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explode</h4>
<pre>public abstract&nbsp;boolean&nbsp;explode</pre>
<div class="block">When explode is set to true, property values of type array or object generate separate parameters for each value
of the array, or key-value-pair of the map.
<p>
For other types of properties this property has no effect. When style is form, the default value is true.
</p>
For all other styles, the default value is false.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this array type encoding will have separate parameters generated for each array value</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="allowReserved--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowReserved</h4>
<pre>public abstract&nbsp;boolean&nbsp;allowReserved</pre>
<div class="block">Determines whether the encoding instance value SHOULD allow reserved characters, as defined by RFC3986 to be
included without percent-encoding.
<p>
See RFC3986 for full definition of reserved characters.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this encoding instance allows reserved characters</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="headers--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>headers</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/headers/Header.html" title="annotation in org.eclipse.microprofile.openapi.annotations.headers">Header</a>[]&nbsp;headers</pre>
<div class="block">An array of headers that corresponds to a map of headers in the encoding model. Allows additional information to
be provided as headers.
<p>
For example, Content-Disposition.
</p>
Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the
request body media type is not a multipart.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the array of headers for this encoding instance</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</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/annotations/media/DiscriminatorMapping.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/ExampleObject.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/annotations/media/Encoding.html" target="_top">Frames</a></li>
<li><a href="Encoding.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>