You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/26 00:43:53 UTC
[09/51] [partial] incubator-juneau-website git commit: Update
javadocs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/swagger/Info.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Info.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Info.html
index 18feace..7cae6cd 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/Info.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Info.html
@@ -114,9 +114,10 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre><a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a>="title,description,termsOfService,contact,license,version")
-public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.50">Info</a>
+public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.52">Info</a>
extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></pre>
-<div class="block">The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
+<div class="block">The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented
+ in the Swagger-UI for convenience.
<h5 class='section'>Example:</h5>
<p class='bcode'>
@@ -139,7 +140,8 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ (org.apache.juneau.dto)</a>
<ul>
<li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
</ul>
@@ -323,7 +325,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>Info</h4>
-<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.50">Info</a>()</pre>
+<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.52">Info</a>()</pre>
</li>
</ul>
</li>
@@ -340,7 +342,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getTitle</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.66">getTitle</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.68">getTitle</a>()</pre>
<div class="block">Bean property getter: <property>title</property>.
<p>
Required. The title of the application.</div>
@@ -356,7 +358,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setTitle</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.78">setTitle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.80">setTitle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title)</pre>
<div class="block">Bean property setter: <property>title</property>.
<p>
Required. The title of the application.</div>
@@ -374,7 +376,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>title</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.89">title</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.91">title</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Info.html#setTitle-java.lang.String-"><code>setTitle(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -390,13 +392,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.100">getDescription</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.103">getDescription</a>()</pre>
<div class="block">Bean property getter: <property>description</property>.
<p>
A short description of the application. GFM syntax can be used for rich text representation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ set.</dd>
</dl>
</li>
</ul>
@@ -406,7 +409,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.112">setDescription</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.115">setDescription</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre>
<div class="block">Bean property setter: <property>description</property>.
<p>
A short description of the application. GFM syntax can be used for rich text representation.</div>
@@ -424,7 +427,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.123">description</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.126">description</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Info.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -440,13 +443,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getTermsOfService</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.134">getTermsOfService</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.138">getTermsOfService</a>()</pre>
<div class="block">Bean property getter: <property>termsOfService</property>.
<p>
The Terms of Service for the API.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not
+ set.</dd>
</dl>
</li>
</ul>
@@ -456,7 +460,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setTermsOfService</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.146">setTermsOfService</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> termsOfService)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.150">setTermsOfService</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> termsOfService)</pre>
<div class="block">Bean property setter: <property>termsOfService</property>.
<p>
The Terms of Service for the API.</div>
@@ -474,7 +478,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>termsOfService</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.157">termsOfService</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> termsOfService)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.161">termsOfService</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> termsOfService)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Info.html#setTermsOfService-java.lang.String-"><code>setTermsOfService(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -490,7 +494,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getContact</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.168">getContact</a>()</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.172">getContact</a>()</pre>
<div class="block">Bean property getter: <property>contact</property>.
<p>
The contact information for the exposed API.</div>
@@ -506,7 +510,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setContact</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.180">setContact</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> contact)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.184">setContact</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> contact)</pre>
<div class="block">Bean property setter: <property>contact</property>.
<p>
The contact information for the exposed API.</div>
@@ -524,7 +528,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>contact</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.191">contact</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> contact)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.195">contact</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> contact)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Info.html#setContact-org.apache.juneau.dto.swagger.Contact-"><code>setContact(Contact)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -540,7 +544,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getLicense</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.202">getLicense</a>()</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.206">getLicense</a>()</pre>
<div class="block">Bean property getter: <property>license</property>.
<p>
The license information for the exposed API.</div>
@@ -556,7 +560,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setLicense</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.214">setLicense</a>(<a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> license)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.218">setLicense</a>(<a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> license)</pre>
<div class="block">Bean property setter: <property>license</property>.
<p>
The license information for the exposed API.</div>
@@ -574,7 +578,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>license</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.225">license</a>(<a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> license)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.229">license</a>(<a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> license)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Info.html#setLicense-org.apache.juneau.dto.swagger.License-"><code>setLicense(License)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -590,7 +594,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.236">getVersion</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.240">getVersion</a>()</pre>
<div class="block">Bean property getter: <property>version</property>.
<p>
Required. Provides the version of the application API (not to be confused with the specification version).</div>
@@ -606,7 +610,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setVersion</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.248">setVersion</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.252">setVersion</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version)</pre>
<div class="block">Bean property setter: <property>version</property>.
<p>
Required. Provides the version of the application API (not to be confused with the specification version).</div>
@@ -624,7 +628,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>version</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.259">version</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Info.html#line.263">version</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Info.html#setVersion-java.lang.String-"><code>setVersion(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>