Google Git
Sign in
apache / tomee-site-pub / 4a7d346c5bbf7aa5d7b83b1cb3ab2e5a84d7328f / . / microprofile-2.0 / javadoc / org / eclipse / microprofile / openapi / models / servers / ServerVariable.html
blob: 365b7847a5a7c0256dbfcfd013b86907e3bc2c6d [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>ServerVariable</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="ServerVariable";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariables.html" title="interface in org.eclipse.microprofile.openapi.models.servers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" target="_top">Frames</a></li>
<li><a href="ServerVariable.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.servers</div>
<h2 title="Interface ServerVariable" class="title">Interface ServerVariable</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></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ServerVariable</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></pre>
<div class="block">An object representing a Server Variable for server URL template substitution.</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#server-variable-object">ServerVariable 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></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/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html#addEnumeration-java.lang.String-">addEnumeration</a></span>(java.lang.String&nbsp;enumeration)</code>
<div class="block">This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html#defaultValue-java.lang.String-">defaultValue</a></span>(java.lang.String&nbsp;defaultValue)</code>
<div class="block">The default value to use for substitution, and to send, if an alternate value is not supplied.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html#description-java.lang.String-">description</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html#enumeration-java.util.List-">enumeration</a></span>(java.util.List&lt;java.lang.String&gt;&nbsp;enumeration)</code>
<div class="block">This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified 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/servers/ServerVariable.html#getDefaultValue--">getDefaultValue</a></span>()</code>
<div class="block">The default value to use for substitution, and to send, if an alternate value is not supplied.</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/servers/ServerVariable.html#getDescription--">getDescription</a></span>()</code>
<div class="block">This method returns the description property of ServerVariable instance.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html#getEnumeration--">getEnumeration</a></span>()</code>
<div class="block">This method returns the enumeration property of ServerVariable instance.</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/servers/ServerVariable.html#setDefaultValue-java.lang.String-">setDefaultValue</a></span>(java.lang.String&nbsp;defaultValue)</code>
<div class="block">The default value to use for substitution, and to send, if an alternate value is not supplied.</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/servers/ServerVariable.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">This method sets the description property of ServerVariable instance to the given description argument.</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/servers/ServerVariable.html#setEnumeration-java.util.List-">setEnumeration</a></span>(java.util.List&lt;java.lang.String&gt;&nbsp;enumeration)</code>
<div class="block">This method sets the enumeration property of ServerVariable instance to the given enumeration argument.</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#getExtensions--">getExtensions</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="getEnumeration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnumeration</h4>
<pre>java.util.List&lt;java.lang.String&gt;&nbsp;getEnumeration()</pre>
<div class="block">This method returns the enumeration property of ServerVariable instance.
<p>
This property represents an enumeration of string values to be used if the substitution options are from a limited set
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List&lt;String&gt; enumeration</dd>
</dl>
</li>
</ul>
<a name="setEnumeration-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnumeration</h4>
<pre>void&nbsp;setEnumeration(java.util.List&lt;java.lang.String&gt;&nbsp;enumeration)</pre>
<div class="block">This method sets the enumeration property of ServerVariable instance to the given enumeration argument.
<p>
This property represents an enumeration of string values to be used if the substitution options are from a limited set
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enumeration</code> - an list of string values to be used if the substitution options are from a limited set</dd>
</dl>
</li>
</ul>
<a name="enumeration-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enumeration</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a>&nbsp;enumeration(java.util.List&lt;java.lang.String&gt;&nbsp;enumeration)</pre>
<div class="block">This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified instance.
<p>
This property represents an enum of string values to be used if the substitution options are from a limited set.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enumeration</code> - an list of string values to be used if the substitution options are from a limited set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ServerVariable instance with the set enumeration property</dd>
</dl>
</li>
</ul>
<a name="addEnumeration-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEnumeration</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a>&nbsp;addEnumeration(java.lang.String&nbsp;enumeration)</pre>
<div class="block">This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.
<p>
If the enumeration list is null, this method should create a new ArrayList and add the item.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enumeration</code> - an item to be added to enum list</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ServerVariable instance with the added enum item.</dd>
</dl>
</li>
</ul>
<a name="getDefaultValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultValue</h4>
<pre>java.lang.String&nbsp;getDefaultValue()</pre>
<div class="block">The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be provided by the consumer and
is REQUIRED.
<p>
This method returns the defaultValue property from ServerVariable instance.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String defaultValue</dd>
</dl>
</li>
</ul>
<a name="setDefaultValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultValue</h4>
<pre>void&nbsp;setDefaultValue(java.lang.String&nbsp;defaultValue)</pre>
<div class="block">The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be provided by the consumer and
is REQUIRED.
<p>
This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - the value to use for substitution, and to send, if an alternate value is not supplied</dd>
</dl>
</li>
</ul>
<a name="defaultValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a>&nbsp;defaultValue(java.lang.String&nbsp;defaultValue)</pre>
<div class="block">The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be provided by the consumer and
is REQUIRED.
<p>
This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument and returns the modified instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - the value to use for substitution, and to send, if an alternate value is not supplied</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ServerVariable instance with the set defaultValue property</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">This method returns the description property of ServerVariable instance. Description property is optional for server variable.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String description</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">This method sets the description property of ServerVariable instance to the given description argument.
<p>
Description property is optional for server variable. CommonMark syntax can be used for rich text representation.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a short description of the server variable</dd>
</dl>
</li>
</ul>
<a name="description-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>description</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" title="interface in org.eclipse.microprofile.openapi.models.servers">ServerVariable</a>&nbsp;description(java.lang.String&nbsp;description)</pre>
<div class="block">This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.
<p>
Description property is optional for server variable. CommonMark syntax can be used for rich text representation.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a short description of the server variable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ServerVariable instance with the set description property</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/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/ServerVariables.html" title="interface in org.eclipse.microprofile.openapi.models.servers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/servers/ServerVariable.html" target="_top">Frames</a></li>
<li><a href="ServerVariable.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>