| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Extensible</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="Extensible"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":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/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/models/Extensible.html" target="_top">Frames</a></li> |
| <li><a href="Extensible.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</div> |
| <h2 title="Interface Extensible" class="title">Interface Extensible</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info">Contact</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/media/Encoding.html" title="interface in org.eclipse.microprofile.openapi.models.media">Encoding</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info">License</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media">MediaType</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlow.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlow</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/security/OAuthFlows.html" title="interface in org.eclipse.microprofile.openapi.models.security">OAuthFlows</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/security/Scopes.html" title="interface in org.eclipse.microprofile.openapi.models.security">Scopes</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariables.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariables</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Extensible</span></pre> |
| <div class="block">The base interface for OpenAPI model objects that can contain extensions. Extensions contain data not required by the specification and may or may |
| not be supported by the tools you use. |
| <p> |
| The extensions property names are always prefixed by "x-".</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#addExtension-java.lang.String-java.lang.Object-">addExtension</a></span>(java.lang.String name, |
| java.lang.Object value)</code> |
| <div class="block">Adds the given object to this Extensible's map of extensions, with the given name as its key.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#getExtensions--">getExtensions</a></span>()</code> |
| <div class="block">Returns the extensions property from an Extensible instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#setExtensions-java.util.Map-">setExtensions</a></span>(java.util.Map<java.lang.String,java.lang.Object> extensions)</code> |
| <div class="block">Sets this Extensible's extensions property to the given map of extensions.</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="getExtensions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtensions</h4> |
| <pre>java.util.Map<java.lang.String,java.lang.Object> getExtensions()</pre> |
| <div class="block">Returns the extensions property from an Extensible instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map containing keys which start with "x-" and values which provide additional information</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addExtension-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExtension</h4> |
| <pre>void addExtension(java.lang.String name, |
| java.lang.Object value)</pre> |
| <div class="block">Adds the given object to this Extensible's map of extensions, with the given name as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the key used to access the extension object. Always prefixed by "x-".</dd> |
| <dd><code>value</code> - data not required by the specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExtensions-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setExtensions</h4> |
| <pre>void setExtensions(java.util.Map<java.lang.String,java.lang.Object> extensions)</pre> |
| <div class="block">Sets this Extensible's extensions property to the given map of extensions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>extensions</code> - map containing keys which start with "x-" and values which provide additional information</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/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/models/Extensible.html" target="_top">Frames</a></li> |
| <li><a href="Extensible.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> |
