| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Discriminator</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="Discriminator"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":18,"i5":6,"i6":6,"i7":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><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.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.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/Discriminator.html" target="_top">Frames</a></li> |
| <li><a href="Discriminator.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 Discriminator" class="title">Interface Discriminator</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">Discriminator</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">Discriminator |
| <p> |
| When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be |
| used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema |
| which is used to inform the consumer of the specification of an alternative schema based on the value associated with |
| it. |
| <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#discriminator-object">OpenAPI |
| Specification Discriminator 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><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/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html#addMapping-java.lang.String-java.lang.String-">addMapping</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Maps the given name to the given value and stores it in this Discriminator's mapping property.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html#getMapping--">getMapping</a></span>()</code> |
| <div class="block">Returns the mapping property from a Discriminator instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html#getPropertyName--">getPropertyName</a></span>()</code> |
| <div class="block">Returns the propertyName property from a Discriminator instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html#mapping-java.util.Map-">mapping</a></span>(java.util.Map<java.lang.String,java.lang.String> mapping)</code> |
| <div class="block">Sets this Discriminator's mapping property to the given map object.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html#propertyName-java.lang.String-">propertyName</a></span>(java.lang.String propertyName)</code> |
| <div class="block">Sets this Discriminator's propertyName property to the given string.</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/Discriminator.html#removeMapping-java.lang.String-">removeMapping</a></span>(java.lang.String name)</code> |
| <div class="block">Remove the given name to the given value and stores it in this Discriminator's mapping property.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html#setMapping-java.util.Map-">setMapping</a></span>(java.util.Map<java.lang.String,java.lang.String> mapping)</code> |
| <div class="block">Sets this Discriminator's mapping property to the given map object.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html#setPropertyName-java.lang.String-">setPropertyName</a></span>(java.lang.String propertyName)</code> |
| <div class="block">Sets this Discriminator's propertyName property to the given propertyName.</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="propertyName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>propertyName</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> propertyName(java.lang.String propertyName)</pre> |
| <div class="block">Sets this Discriminator's propertyName property to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - the name of the property in the payload that will hold the discriminator value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Discriminator instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPropertyName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyName</h4> |
| <pre>java.lang.String getPropertyName()</pre> |
| <div class="block">Returns the propertyName property from a Discriminator instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the property in the payload that will hold the discriminator value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPropertyName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPropertyName</h4> |
| <pre>void setPropertyName(java.lang.String propertyName)</pre> |
| <div class="block">Sets this Discriminator's propertyName property to the given propertyName.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - the name of the property in the payload that will hold the discriminator value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMapping-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> addMapping(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Maps the given name to the given value and stores it in this Discriminator's mapping property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a key which will be compared to information from a request body or response payload.</dd> |
| <dd><code>value</code> - a schema name or reference. null values will be rejected (implementation will throw an exception) or |
| ignored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Discriminator instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeMapping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMapping</h4> |
| <pre>void removeMapping(java.lang.String name)</pre> |
| <div class="block">Remove the given name to the given value and stores it in this Discriminator's mapping property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a key which will be compared to information from a request body or response payload.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mapping-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mapping</h4> |
| <pre>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> mapping(java.util.Map<java.lang.String,java.lang.String> mapping)</pre> |
| <div class="block">Sets this Discriminator's mapping property to the given map object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mapping</code> - a map containing keys and schema names or references</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Discriminator instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapping</h4> |
| <pre>java.util.Map<java.lang.String,java.lang.String> getMapping()</pre> |
| <div class="block">Returns the mapping property from a Discriminator instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy Map (potentially immutable) containing keys and schema names or references</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMapping-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setMapping</h4> |
| <pre>void setMapping(java.util.Map<java.lang.String,java.lang.String> mapping)</pre> |
| <div class="block">Sets this Discriminator's mapping property to the given map object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mapping</code> - a map containing keys and schema names or references</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/Content.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.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/Discriminator.html" target="_top">Frames</a></li> |
| <li><a href="Discriminator.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> |
