blob: 88378ea4fd76ff7e373b7fb630126de28c3c2b1c [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>Example</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="Example";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":18,"i11":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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/examples/Example.html" target="_top">Frames</a></li>
<li><a href="Example.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.examples</div>
<h2 title="Interface Example" class="title">Interface Example</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>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Example</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>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;</pre>
<div class="block">Example
<p>
An object containing sample data for the related object.
<p>
In all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling
implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.</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#exampleObject">OpenAPI
Specification Example 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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>default <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/examples/Example.html#description-java.lang.String-">description</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets this Example's description property to the given string.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default <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/examples/Example.html#externalValue-java.lang.String-">externalValue</a></span>(java.lang.String&nbsp;externalValue)</code>
<div class="block">Sets this Example's externalValue property to the given string.</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/examples/Example.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns the description property from an Example instance.</div>
</td>
</tr>
<tr id="i3" 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/examples/Example.html#getExternalValue--">getExternalValue</a></span>()</code>
<div class="block">Returns the externalValue property from an Example instance.</div>
</td>
</tr>
<tr id="i4" 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/examples/Example.html#getSummary--">getSummary</a></span>()</code>
<div class="block">Returns the summary property from an Example instance.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html#getValue--">getValue</a></span>()</code>
<div class="block">Returns the value property from an Example instance.</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/examples/Example.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets this Example's description property to the given string.</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/examples/Example.html#setExternalValue-java.lang.String-">setExternalValue</a></span>(java.lang.String&nbsp;externalValue)</code>
<div class="block">Sets this Example's externalValue property to the given string.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html#setSummary-java.lang.String-">setSummary</a></span>(java.lang.String&nbsp;summary)</code>
<div class="block">Sets this Example's summary property to the given string.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html#setValue-java.lang.Object-">setValue</a></span>(java.lang.Object&nbsp;value)</code>
<div class="block">Sets this Example's value property to the given value.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>default <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/examples/Example.html#summary-java.lang.String-">summary</a></span>(java.lang.String&nbsp;summary)</code>
<div class="block">Sets this Example's summary property to the given string.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>default <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/examples/Example.html#value-java.lang.Object-">value</a></span>(java.lang.Object&nbsp;value)</code>
<div class="block">Sets this Example's value property to the given 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&nbsp;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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Reference">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.microprofile.openapi.models.<a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a></h3>
<code><a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#getRef--">getRef</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#ref-java.lang.String-">ref</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#setRef-java.lang.String-">setRef</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="getSummary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSummary</h4>
<pre>java.lang.String&nbsp;getSummary()</pre>
<div class="block">Returns the summary property from an Example instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>short description of the example</dd>
</dl>
</li>
</ul>
<a name="setSummary-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSummary</h4>
<pre>void&nbsp;setSummary(java.lang.String&nbsp;summary)</pre>
<div class="block">Sets this Example's summary property to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>summary</code> - short description of the example</dd>
</dl>
</li>
</ul>
<a name="summary-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>summary</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&nbsp;summary(java.lang.String&nbsp;summary)</pre>
<div class="block">Sets this Example's summary property to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>summary</code> - short description of the example</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Example object</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>java.lang.String&nbsp;getDescription()</pre>
<div class="block">Returns the description property from an Example instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>long description of the example</dd>
</dl>
</li>
</ul>
<a name="setDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
<pre>void&nbsp;setDescription(java.lang.String&nbsp;description)</pre>
<div class="block">Sets this Example's description property to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - long description of the example</dd>
</dl>
</li>
</ul>
<a name="description-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&nbsp;description(java.lang.String&nbsp;description)</pre>
<div class="block">Sets this Example's description property to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - long description of the example</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Example object</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.Object&nbsp;getValue()</pre>
<div class="block">Returns the value property from an Example instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>embedded literal example object</dd>
</dl>
</li>
</ul>
<a name="setValue-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>void&nbsp;setValue(java.lang.Object&nbsp;value)</pre>
<div class="block">Sets this Example's value property to the given value. The value field and externalValue field are mutually
exclusive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - a literal example object</dd>
</dl>
</li>
</ul>
<a name="value-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>value</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&nbsp;value(java.lang.Object&nbsp;value)</pre>
<div class="block">Sets this Example's value property to the given value. The value field and externalValue field are mutually
exclusive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - a literal example object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Example object</dd>
</dl>
</li>
</ul>
<a name="getExternalValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalValue</h4>
<pre>java.lang.String&nbsp;getExternalValue()</pre>
<div class="block">Returns the externalValue property from an Example instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL that points to the literal example</dd>
</dl>
</li>
</ul>
<a name="setExternalValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalValue</h4>
<pre>void&nbsp;setExternalValue(java.lang.String&nbsp;externalValue)</pre>
<div class="block">Sets this Example's externalValue property to the given string. The value field and externalValue field are
mutually exclusive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>externalValue</code> - URL that points to the literal example</dd>
</dl>
</li>
</ul>
<a name="externalValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>externalValue</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&nbsp;externalValue(java.lang.String&nbsp;externalValue)</pre>
<div class="block">Sets this Example's externalValue property to the given string. The value field and externalValue field are
mutually exclusive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>externalValue</code> - URL that points to the literal example</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Example object</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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/examples/Example.html" target="_top">Frames</a></li>
<li><a href="Example.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>