Google Git
Sign in
apache / tomee-site-pub / 504059d7503a007b82c04535fee5e5878ca4d30e / . / microprofile-4.1 / javadoc / org / eclipse / microprofile / openapi / models / info / Info.html
blob: a8734e16d780c015d13386587b67013834f600c9 [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>Info</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="Info";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":18,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":18,"i16":18,"i17":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><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/info/Info.html" target="_top">Frames</a></li>
<li><a href="Info.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.info</div>
<h2 title="Interface Info" class="title">Interface Info</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/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Info</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/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&gt;</pre>
<div class="block">This interface represents all the metadata about the API. The metadata may be used by clients if needed, and may be presented in editing or
documentation tools.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.md#infoObject"</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/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#contact-org.eclipse.microprofile.openapi.models.info.Contact-">contact</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info">Contact</a>&nbsp;contact)</code>
<div class="block">Sets this Info instance's contact information for the exposed API and returns this instance of Info.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#description-java.lang.String-">description</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets this Info instance's description for the application to the given description and returns this instance of Info.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info">Contact</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#getContact--">getContact</a></span>()</code>
<div class="block">Returns the contact information for the exposed API from this Info 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/info/Info.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns a short description for the application for this Info instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info">License</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#getLicense--">getLicense</a></span>()</code>
<div class="block">Returns the license information for the exposed API from this Info instance.</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/info/Info.html#getTermsOfService--">getTermsOfService</a></span>()</code>
<div class="block">Returns the URL to the Terms of Service for the API for this instance of Info.</div>
</td>
</tr>
<tr id="i6" 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/info/Info.html#getTitle--">getTitle</a></span>()</code>
<div class="block">Returns the title for the application for this instance of Info</div>
</td>
</tr>
<tr id="i7" 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/info/Info.html#getVersion--">getVersion</a></span>()</code>
<div class="block">Returns the version of the OpenAPI document for this Info instance.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#license-org.eclipse.microprofile.openapi.models.info.License-">license</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info">License</a>&nbsp;license)</code>
<div class="block">Sets this Info's license information for the exposed API and returns this instance of Info.</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/info/Info.html#setContact-org.eclipse.microprofile.openapi.models.info.Contact-">setContact</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info">Contact</a>&nbsp;contact)</code>
<div class="block">Sets this Info instance's contact information for the exposed API.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets this Info instance's description for the application to the given description.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#setLicense-org.eclipse.microprofile.openapi.models.info.License-">setLicense</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info">License</a>&nbsp;license)</code>
<div class="block">Sets this Info's license information for the exposed API.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#setTermsOfService-java.lang.String-">setTermsOfService</a></span>(java.lang.String&nbsp;termsOfService)</code>
<div class="block">Sets this Info instance's URL to the Terms of Service for the API to the given String.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String&nbsp;title)</code>
<div class="block">Sets this Info instance's title for the application to the given title.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#setVersion-java.lang.String-">setVersion</a></span>(java.lang.String&nbsp;version)</code>
<div class="block">Sets the version of the OpenAPI document for this instance of Info to the given version.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#termsOfService-java.lang.String-">termsOfService</a></span>(java.lang.String&nbsp;termsOfService)</code>
<div class="block">Sets this Info instance's URL to the Terms of Service for the API to the given String and returns this instance of Info.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#title-java.lang.String-">title</a></span>(java.lang.String&nbsp;title)</code>
<div class="block">Sets this Info instance's title for the application to the given title and returns this instance of Info</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html#version-java.lang.String-">version</a></span>(java.lang.String&nbsp;version)</code>
<div class="block">Sets the version of the OpenAPI document for this instance of Info to the given version and returns this instance of Info</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>
</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="getTitle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTitle</h4>
<pre>java.lang.String&nbsp;getTitle()</pre>
<div class="block">Returns the title for the application for this instance of Info</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the title of the application</dd>
</dl>
</li>
</ul>
<a name="setTitle-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTitle</h4>
<pre>void&nbsp;setTitle(java.lang.String&nbsp;title)</pre>
<div class="block">Sets this Info instance's title for the application to the given title.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>title</code> - the title of the application</dd>
</dl>
</li>
</ul>
<a name="title-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>title</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&nbsp;title(java.lang.String&nbsp;title)</pre>
<div class="block">Sets this Info instance's title for the application to the given title and returns this instance of Info</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>title</code> - the title of the application</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Info instance</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 a short description for the application for this Info instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a short description of the application</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 Info instance's description for the application to the given description.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a short description for the application</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/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&nbsp;description(java.lang.String&nbsp;description)</pre>
<div class="block">Sets this Info instance's description for the application to the given description and returns this instance of Info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a short description for the application</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Info instance</dd>
</dl>
</li>
</ul>
<a name="getTermsOfService--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTermsOfService</h4>
<pre>java.lang.String&nbsp;getTermsOfService()</pre>
<div class="block">Returns the URL to the Terms of Service for the API for this instance of Info.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a URL to the Terms of Service for the API</dd>
</dl>
</li>
</ul>
<a name="setTermsOfService-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTermsOfService</h4>
<pre>void&nbsp;setTermsOfService(java.lang.String&nbsp;termsOfService)</pre>
<div class="block">Sets this Info instance's URL to the Terms of Service for the API to the given String. The URL must be in the format of a URL.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>termsOfService</code> - the URL to the Terms of Service for the API</dd>
</dl>
</li>
</ul>
<a name="termsOfService-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>termsOfService</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&nbsp;termsOfService(java.lang.String&nbsp;termsOfService)</pre>
<div class="block">Sets this Info instance's URL to the Terms of Service for the API to the given String and returns this instance of Info. The URL must be in the
format of a URL.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>termsOfService</code> - the URL to the Terms of Service for the API</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Info instance</dd>
</dl>
</li>
</ul>
<a name="getContact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContact</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info">Contact</a>&nbsp;getContact()</pre>
<div class="block">Returns the contact information for the exposed API from this Info instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the contact information for the exposed API</dd>
</dl>
</li>
</ul>
<a name="setContact-org.eclipse.microprofile.openapi.models.info.Contact-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContact</h4>
<pre>void&nbsp;setContact(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info">Contact</a>&nbsp;contact)</pre>
<div class="block">Sets this Info instance's contact information for the exposed API.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contact</code> - the contact information for the exposed API</dd>
</dl>
</li>
</ul>
<a name="contact-org.eclipse.microprofile.openapi.models.info.Contact-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contact</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&nbsp;contact(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info">Contact</a>&nbsp;contact)</pre>
<div class="block">Sets this Info instance's contact information for the exposed API and returns this instance of Info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contact</code> - the contact information for the exposed API</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Info instance</dd>
</dl>
</li>
</ul>
<a name="getLicense--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLicense</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info">License</a>&nbsp;getLicense()</pre>
<div class="block">Returns the license information for the exposed API from this Info instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the license information for the exposed API</dd>
</dl>
</li>
</ul>
<a name="setLicense-org.eclipse.microprofile.openapi.models.info.License-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLicense</h4>
<pre>void&nbsp;setLicense(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info">License</a>&nbsp;license)</pre>
<div class="block">Sets this Info's license information for the exposed API.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>license</code> - the license information for the exposed API</dd>
</dl>
</li>
</ul>
<a name="license-org.eclipse.microprofile.openapi.models.info.License-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>license</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&nbsp;license(<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info">License</a>&nbsp;license)</pre>
<div class="block">Sets this Info's license information for the exposed API and returns this instance of Info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>license</code> - the license information for the exposed API</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Info instance</dd>
</dl>
</li>
</ul>
<a name="getVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>java.lang.String&nbsp;getVersion()</pre>
<div class="block">Returns the version of the OpenAPI document for this Info instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the version of the OpenAPI document</dd>
</dl>
</li>
</ul>
<a name="setVersion-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVersion</h4>
<pre>void&nbsp;setVersion(java.lang.String&nbsp;version)</pre>
<div class="block">Sets the version of the OpenAPI document for this instance of Info to the given version.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>version</code> - the version of the OpenAPI document</dd>
</dl>
</li>
</ul>
<a name="version-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>version</h4>
<pre>default&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a>&nbsp;version(java.lang.String&nbsp;version)</pre>
<div class="block">Sets the version of the OpenAPI document for this instance of Info to the given version and returns this instance of Info</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>version</code> - the version of the OpenAPI document</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Info instance</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/info/Contact.html" title="interface in org.eclipse.microprofile.openapi.models.info"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/models/info/License.html" title="interface in org.eclipse.microprofile.openapi.models.info"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/info/Info.html" target="_top">Frames</a></li>
<li><a href="Info.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>