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/02/17 02:14:08 UTC
[30/36] incubator-juneau-website git commit: Add Swagger examples.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/License.html b/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
index eb5cfc0..74cbf4c 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
@@ -18,8 +18,8 @@
catch(err) {
}
//-->
-var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10};
-var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -99,18 +99,23 @@ var activeTableTab = "activeTableTab";
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
+<li><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">org.apache.juneau.dto.swagger.SwaggerElement</a></li>
+<li>
+<ul class="inheritance">
<li>org.apache.juneau.dto.swagger.License</li>
</ul>
</li>
</ul>
+</li>
+</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<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>="name,url")
-public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.29">License</a>
-extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
+public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.30">License</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">License information for the exposed API.
<h5 class='section'>Example:</h5>
@@ -150,29 +155,29 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/License.html#create-java.lang.String-">create</a></span>(<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> name)</code>
-<div class="block">Convenience method for creating a new License object.</div>
-</td>
-</tr>
-<tr id="i1" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/License.html#getName--">getName</a></span>()</code>
<div class="block">Bean property getter: <property>name</property>.</div>
</td>
</tr>
-<tr id="i2" class="altColor">
+<tr id="i1" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/License.html#getUrl--">getUrl</a></span>()</code>
<div class="block">Bean property getter: <property>url</property>.</div>
</td>
</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/License.html#name-java.lang.String-">name</a></span>(<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> name)</code>
+<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/License.html#setName-java.lang.String-"><code>setName(String)</code></a>.</div>
+</td>
+</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/License.html#setName-java.lang.String-">setName</a></span>(<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> name)</code>
@@ -185,8 +190,21 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<div class="block">Bean property setter: <property>url</property>.</div>
</td>
</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/License.html#url-java.lang.String-">url</a></span>(<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> url)</code>
+<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/License.html#setUrl-java.lang.String-"><code>setUrl(String)</code></a>.</div>
+</td>
+</tr>
</table>
<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.dto.swagger.SwaggerElement">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></h3>
+<code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#isStrict--">isStrict</a>, <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#strict--">strict</a></code></li>
+</ul>
+<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
@@ -213,7 +231,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockListLast">
<li class="blockList">
<h4>License</h4>
-<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.29">License</a>()</pre>
+<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.30">License</a>()</pre>
</li>
</ul>
</li>
@@ -224,29 +242,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<!-- -->
</a>
<h3>Method Detail</h3>
-<a name="create-java.lang.String-">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>create</h4>
-<pre>public static <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/License.html#line.40">create</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> name)</pre>
-<div class="block">Convenience method for creating a new License object.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>name</code> - Required. The license name used for the API.</dd>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>A new License object.</dd>
-</dl>
-</li>
-</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</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/License.html#line.51">getName</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/License.html#line.42">getName</a>()</pre>
<div class="block">Bean property getter: <property>name</property>.
<p>
Required. The license name used for the API.</div>
@@ -262,7 +264,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>setName</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/License.html#line.63">setName</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> name)</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/License.html#line.54">setName</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> name)</pre>
<div class="block">Bean property setter: <property>name</property>.
<p>
Required. The license name used for the API.</div>
@@ -274,13 +276,29 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
</dl>
</li>
</ul>
+<a name="name-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>name</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/License.html#line.65">name</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> name)</pre>
+<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/License.html#setName-java.lang.String-"><code>setName(String)</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - The new value for the <property>name</property> property on this bean.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
<a name="getUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrl</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/License.html#line.75">getUrl</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/License.html#line.76">getUrl</a>()</pre>
<div class="block">Bean property getter: <property>url</property>.
<p>
A URL to the license used for the API. MUST be in the format of a URL.</div>
@@ -293,10 +311,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<a name="setUrl-java.lang.String-">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>setUrl</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/License.html#line.87">setUrl</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> url)</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/License.html#line.88">setUrl</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> url)</pre>
<div class="block">Bean property setter: <property>url</property>.
<p>
A URL to the license used for the API. MUST be in the format of a URL.</div>
@@ -308,6 +326,22 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
</dl>
</li>
</ul>
+<a name="url-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>url</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/License.html#line.99">url</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> url)</pre>
+<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/License.html#setUrl-java.lang.String-"><code>setUrl(String)</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>url</code> - The new value for the <property>url</property> property on this bean.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
</li>