http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/dto/swagger/Tag.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Tag.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Tag.html index 1b3a565..14e7d87 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/Tag.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Tag.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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,"i6":10,"i7":10,"i8":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -48,8 +48,8 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/Temp.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/Tag.html" target="_top">Frames</a></li> @@ -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.Tag</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,description,externalDocs") -public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.31">Tag</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/Tag.html#line.32">Tag</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">Allows adding meta data to a single tag that is used by the <a class="doclink" href="http://swagger.io/specification/#operationObject";>Operation Object</a>. <p> It is not mandatory to have a Tag Object per tag used there. @@ -152,48 +157,60 @@ 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/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.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 Tag object.</div> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#description-java.lang.String-">description</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> description)</code> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div> </td> </tr> <tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#externalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-">externalDocs</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</code> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#setExternalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-"><code>setExternalDocs(ExternalDocumentation)</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> <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/Tag.html#getDescription--">getDescription</a></span>()</code> <div class="block">Bean property getter: <property>description</property>.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#getExternalDocs--">getExternalDocs</a></span>()</code> <div class="block">Bean property getter: <property>externalDocs</property>.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i4" class="altColor"> <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/Tag.html#getName--">getName</a></span>()</code> <div class="block">Bean property getter: <property>name</property>.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.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/Tag.html#setName-java.lang.String-"><code>setName(String)</code></a>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#setDescription-java.lang.String-">setDescription</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> description)</code> <div class="block">Bean property setter: <property>description</property>.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#setExternalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-">setExternalDocs</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</code> <div class="block">Bean property setter: <property>externalDocs</property>.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.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> <div class="block">Bean property setter: <property>name</property>.</div> @@ -201,6 +218,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </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> @@ -227,7 +251,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>Tag</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.31">Tag</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.32">Tag</a>()</pre> </li> </ul> </li> @@ -238,29 +262,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/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.43">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 Tag object.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - Required. The name of the tag.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A new Tag 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/Tag.html#line.54">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/Tag.html#line.45">getName</a>()</pre> <div class="block">Bean property getter: <property>name</property>. <p> Required. The name of the tag.</div> @@ -276,7 +284,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/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.66">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/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.57">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 name of the tag.</div> @@ -288,13 +296,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/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.68">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/Tag.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="getDescription--"> <!-- --> </a> <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/Tag.html#line.79">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/Tag.html#line.80">getDescription</a>()</pre> <div class="block">Bean property getter: <property>description</property>. <p> A short description for the tag. @@ -311,7 +335,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>setDescription</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.92">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/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.93">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 for the tag. @@ -324,13 +348,29 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="description-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>description</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.104">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/Tag.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>description</code> - The new value for the <property>description</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="getExternalDocs--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getExternalDocs</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.104">getExternalDocs</a>()</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.115">getExternalDocs</a>()</pre> <div class="block">Bean property getter: <property>externalDocs</property>. <p> Additional external documentation for this tag.</div> @@ -343,10 +383,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <a name="setExternalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>setExternalDocs</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.116">setExternalDocs</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.127">setExternalDocs</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</pre> <div class="block">Bean property setter: <property>externalDocs</property>. <p> Additional external documentation for this tag.</div> @@ -358,6 +398,22 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="externalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>externalDocs</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Tag.html#line.138">externalDocs</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</pre> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Tag.html#setExternalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-"><code>setExternalDocs(ExternalDocumentation)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>externalDocs</code> - The new value for the <property>externalDocs</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> @@ -385,8 +441,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/Temp.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/Tag.html" target="_top">Frames</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/dto/swagger/Temp.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Temp.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Temp.html new file mode 100644 index 0000000..a291696 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Temp.html @@ -0,0 +1,276 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Temp (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Temp (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/Temp.html" target="_top">Frames</a></li> +<li><a href="Temp.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.apache.juneau.dto.swagger</div> +<h2 title="Class Temp" class="title">Class Temp</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<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>org.apache.juneau.dto.swagger.Temp</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Temp.html#line.24">Temp</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> +<div class="block">TODO</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Temp.html#Temp--">Temp</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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 void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Temp.html#main-java.lang.String:A-">main</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>[] args)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Temp--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Temp</h4> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Temp.html#line.24">Temp</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="main-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Temp.html#line.26">main</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>[] args) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></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/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/Temp.html" target="_top">Frames</a></li> +<li><a href="Temp.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/dto/swagger/Xml.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Xml.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Xml.html index 587c448..11e8024 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/Xml.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Xml.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":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,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/Temp.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> @@ -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.Xml</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,namespace,prefix,attribute,wrapped") -public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.23">Xml</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/Xml.html#line.24">Xml</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">A metadata object that allows for more fine-tuned XML model definitions. <p> When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.</div> @@ -144,15 +149,15 @@ 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/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#create--">create</a></span>()</code> -<div class="block">Convenience method for creating a new Xml object.</div> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#attribute-java.lang.Boolean-">attribute</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> attribute)</code> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setAttribute-java.lang.Boolean-"><code>setAttribute(Boolean)</code></a>.</div> </td> </tr> <tr id="i1" class="rowColor"> @@ -187,36 +192,67 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.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/Xml.html#setName-java.lang.String-"><code>setName(String)</code></a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#namespace-java.lang.String-">namespace</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> namespace)</code> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setNamespace-java.lang.String-"><code>setNamespace(String)</code></a>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#prefix-java.lang.String-">prefix</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> prefix)</code> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setPrefix-java.lang.String-"><code>setPrefix(String)</code></a>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setAttribute-java.lang.Boolean-">setAttribute</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> attribute)</code> <div class="block">Bean property setter: <property>attribute</property>.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.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> <div class="block">Bean property setter: <property>name</property>.</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setNamespace-java.lang.String-">setNamespace</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> namespace)</code> <div class="block">Bean property setter: <property>namespace</property>.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setPrefix-java.lang.String-">setPrefix</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> prefix)</code> <div class="block">Bean property setter: <property>prefix</property>.</div> </td> </tr> -<tr id="i10" class="altColor"> +<tr id="i13" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setWrapped-java.lang.Boolean-">setWrapped</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> wrapped)</code> <div class="block">Bean property setter: <property>wrapped</property>.</div> </td> </tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#wrapped-java.lang.Boolean-">wrapped</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> wrapped)</code> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setWrapped-java.lang.Boolean-"><code>setWrapped(Boolean)</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> @@ -243,7 +279,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>Xml</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.23">Xml</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.24">Xml</a>()</pre> </li> </ul> </li> @@ -254,27 +290,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <!-- --> </a> <h3>Method Detail</h3> -<a name="create--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>create</h4> -<pre>public static <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.36">create</a>()</pre> -<div class="block">Convenience method for creating a new Xml object.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A new Xml 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/Xml.html#line.50">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/Xml.html#line.42">getName</a>()</pre> <div class="block">Bean property getter: <property>name</property>. <p> Replaces the name of the element/attribute used for the described schema property. @@ -293,7 +315,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/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.65">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/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.57">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> Replaces the name of the element/attribute used for the described schema property. @@ -308,13 +330,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/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.68">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/Xml.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="getNamespace--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNamespace</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/Xml.html#line.77">getNamespace</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/Xml.html#line.79">getNamespace</a>()</pre> <div class="block">Bean property getter: <property>namespace</property>. <p> The URL of the namespace definition. Value SHOULD be in the form of a URL.</div> @@ -330,7 +368,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>setNamespace</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.89">setNamespace</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> namespace)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.91">setNamespace</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> namespace)</pre> <div class="block">Bean property setter: <property>namespace</property>. <p> The URL of the namespace definition. Value SHOULD be in the form of a URL.</div> @@ -342,13 +380,29 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="namespace-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>namespace</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.102">namespace</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> namespace)</pre> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setNamespace-java.lang.String-"><code>setNamespace(String)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>namespace</code> - The new value for the <property>namespace</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="getPrefix--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPrefix</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/Xml.html#line.101">getPrefix</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/Xml.html#line.113">getPrefix</a>()</pre> <div class="block">Bean property getter: <property>prefix</property>. <p> The prefix to be used for the name.</div> @@ -364,7 +418,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>setPrefix</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.113">setPrefix</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> prefix)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.125">setPrefix</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> prefix)</pre> <div class="block">Bean property setter: <property>prefix</property>. <p> The prefix to be used for the name.</div> @@ -376,13 +430,29 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="prefix-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prefix</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.136">prefix</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> prefix)</pre> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setPrefix-java.lang.String-"><code>setPrefix(String)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>prefix</code> - The new value for the <property>prefix</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="getAttribute--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAttribute</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.125">getAttribute</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.147">getAttribute</a>()</pre> <div class="block">Bean property getter: <property>attribute</property>. <p> Declares whether the property definition translates to an attribute instead of an element. Default value is <jk>false</jk>.</div> @@ -398,7 +468,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>setAttribute</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.137">setAttribute</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> attribute)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.159">setAttribute</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> attribute)</pre> <div class="block">Bean property setter: <property>attribute</property>. <p> Declares whether the property definition translates to an attribute instead of an element. Default value is <jk>false</jk>.</div> @@ -410,13 +480,29 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="attribute-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>attribute</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.170">attribute</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> attribute)</pre> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setAttribute-java.lang.Boolean-"><code>setAttribute(Boolean)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>attribute</code> - The new value for the <property>attribute</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="getWrapped--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getWrapped</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.152">getWrapped</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.184">getWrapped</a>()</pre> <div class="block">Bean property getter: <property>wrapped</property>. <p> MAY be used only for an array definition. @@ -432,10 +518,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <a name="setWrapped-java.lang.Boolean-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>setWrapped</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.167">setWrapped</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> wrapped)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.199">setWrapped</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> wrapped)</pre> <div class="block">Bean property setter: <property>wrapped</property>. <p> MAY be used only for an array definition. @@ -450,6 +536,22 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="wrapped-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wrapped</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Xml.html#line.210">wrapped</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> wrapped)</pre> +<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Xml.html#setWrapped-java.lang.Boolean-"><code>setWrapped(Boolean)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>wrapped</code> - The new value for the <property>wrapped</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> @@ -477,7 +579,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/Temp.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/dto/swagger/package-frame.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/package-frame.html b/content/site/apidocs/org/apache/juneau/dto/swagger/package-frame.html index fa0f64d..7c6ae68 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/package-frame.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/package-frame.html @@ -25,7 +25,10 @@ <li><a href="SchemaInfo.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">SchemaInfo</a></li> <li><a href="SecurityScheme.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">SecurityScheme</a></li> <li><a href="Swagger.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">Swagger</a></li> +<li><a href="SwaggerBuilder.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">SwaggerBuilder</a></li> +<li><a href="SwaggerElement.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">SwaggerElement</a></li> <li><a href="Tag.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">Tag</a></li> +<li><a href="Temp.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">Temp</a></li> <li><a href="Xml.html" title="class in org.apache.juneau.dto.swagger" target="classFrame">Xml</a></li> </ul> </div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html b/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html index ec81acb..a3f4689 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html @@ -158,12 +158,30 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerBuilder.html" title="class in org.apache.juneau.dto.swagger">SwaggerBuilder</a></td> +<td class="colLast"> +<div class="block">Various useful static methods for creating Swagger elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></td> +<td class="colLast"> +<div class="block">Root class for all Swagger beans.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></td> <td class="colLast"> <div class="block">Allows adding meta data to a single tag that is used by the <a class="doclink" href="http://swagger.io/specification/#operationObject";>Operation Object</a>.</div> </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/dto/swagger/Temp.html" title="class in org.apache.juneau.dto.swagger">Temp</a></td> +<td class="colLast"> +<div class="block">TODO</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></td> <td class="colLast"> <div class="block">A metadata object that allows for more fine-tuned XML model definitions.</div> @@ -194,7 +212,160 @@ } } } -</script></div> +</script> +<a id='TOC'></a><h5 class='toc'>Table of Contents</h5> +<ol class='toc'> + <li><p><a class='doclink' href='#Overview'>Overview</a></p> + <ol> + <li><p><a class='doclink' href='#Serialize'>Generating Swagger Docs</a></p> + <li><p><a class='doclink' href='#Parse'>Parsing Swagger Docs</a></p> + </ol> +</ol> + + +<!-- ======================================================================================================== --> +<a id="Overview"></a> +<h2 class='topic' onclick='toggle(this)'>1 - Overview</h2> +<div class='topic'> + <p> + Juneau supports generation and consumption of Swagger 2.0 documents and fragments through the use of DTOs (Data Transfer Objects).<br> + It uses existing support for serializing and parsing POJOs to and from JSON to define these objects. + </p> + + <!-- ======================================================================================================== --> + <a id="Serialize"></a> + <h3 class='topic' onclick='toggle(this)'>1.1 - Generating Swagger Docs</h3> + <div class='topic'> + <p> + The following is an example Swagger document from the <a href="http://petstore.swagger.io/";>Swagger website</a>. + </p> + <p class='bcode'> + { + <jf>"swagger"</jf>: <js>"2.0"</js>, + <jf>"info"</jf>: { + <jf>"title"</jf>: <js>"Swagger Petstore"</js>, + <jf>"description"</jf>: <js>"This is a sample server Petstore server."</js>, + <jf>"version"</jf>: <js>"1.0.0"</js>, + <jf>"termsOfService"</jf>: <js>"http://swagger.io/terms/";</js>, + <jf>"contact"</jf>: { + <jf>"email"</jf>: <js>"[email protected]"</js> + }, + <jf>"license"</jf>: { + <jf>"name"</jf>: <js>"Apache 2.0"</js>, + <jf>"url"</jf>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html";</js> + } + }, + <jf>"host"</jf>: <js>"petstore.swagger.io"</js>, + <jf>"basePath"</jf>: <js>"/v2"</js>, + <jf>"tags"</jf>: [ + { + <jf>"name"</jf>: <js>"pet"</js>, + <jf>"description"</jf>: <js>"Everything about your Pets"</js>, + <jf>"externalDocs"</jf>: { + <jf>"description"</jf>: <js>"Find out more"</js>, + <jf>"url"</jf>: <js>"http://swagger.io";</js> + } + } + ], + <jf>"schemes"</jf>: [ + <js>"http"</js> + ], + <jf>"paths"</jf>: { + <jf>"/pet"</jf>: { + <jf>"post"</jf>: { + <jf>"tags"</jf>: [ + <js>"pet"</js> + ], + <jf>"summary"</jf>: <js>"Add a new pet to the store"</js>, + <jf>"description"</jf>: <js>""</js>, + <jf>"operationId"</jf>: <js>"addPet"</js>, + <jf>"consumes"</jf>: [ + <js>"application/json"</js>, + <js>"text/xml"</js> + ], + <jf>"produces"</jf>: [ + <js>"application/json"</js>, + <js>"text/xml"</js> + ], + <jf>"parameters"</jf>: [ + { + <jf>"in"</jf>: <js>"body"</js>, + <jf>"name"</jf>: <js>"body"</js>, + <jf>"description"</jf>: <js>"Pet object that needs to be added to the store"</js>, + <jf>"required"</jf>: <jk>true</jk> + } + ], + <jf>"responses"</jf>: { + <jf>"405"</jf>: { + <jf>"description"</jf>: <js>"Invalid input"</js> + } + } + } + } + }, + } + </p> + <p> + This document can be generated by the following Java code: + </p> + <p class='bcode'> + <jk>static import</jk> org.apache.juneau.dto.swagger.SwaggerBuilder.*; + + Swagger swagger = <jsm>swagger</jsm>() + .swagger(<js>"2.0"</js>) + .info( + <jsm>info</jsm>(<js>"Swagger Petstore"</js>, <js>"1.0.0"</js>) + .description(<js>"This is a sample server Petstore server."</js>) + .termsOfService(<js>"http://swagger.io/terms/";</js>) + .contact( + <jsm>contact</jsm>().email(<js>"[email protected]"</js>) + ) + .license( + <jsm>license</jsm>(<js>"Apache 2.0"</js>).url(<js>"http://www.apache.org/licenses/LICENSE-2.0.html";</js>) + ) + ) + .host(<js>"petstore.swagger.io"</js>) + .basePath(<js>"/v2"</js>) + .tags( + <jsm>tag</jsm>(<js>"pet"</js>).description(<js>"Everything about your Pets"</js>) + .externalDocs( + <jsm>externalDocumentation</jsm>(<js>"http://swagger.io";</js>, <js>"http://swagger.io";</js>) + ) + ) + .schemes(<js>"http"</js>) + .path(<js>"/pet"</js>, <js>"post"</js>, + <jsm>operation</jsm>() + .tags(<js>"pet"</js>) + .summary(<js>"Add a new pet to the store"</js>) + .description(<js>""</js>) + .operationId(<js>"addPet"</js>) + .consumes(MediaType.<jsf>JSON</jsf>, MediaType.<jsf>XML</jsf>) + .produces(MediaType.<jsf>JSON</jsf>, MediaType.<jsf>XML</jsf>) + .parameters( + <jsm>parameterInfo</jsm>(<js>"body"</js>, <js>"body"</js>) + .description(<js>"Pet object that needs to be added to the store"</js>) + .required(<jk>true</jk>) + ) + .response(405, <jsm>responseInfo</jsm>(<js>"Invalid input"</js>)) + ); + + String swaggerJson = JsonSerializer.<jsf>DEFAULT_READABLE</jsf>.serialize(swagger); + </p> + </div> + + <!-- ======================================================================================================== --> + <a id="Parse"></a> + <h3 class='topic' onclick='toggle(this)'>1.2 - Parsing Swagger Docs</h3> + <div class='topic'> + <p> + Swagger docs can be parsed back into Swagger beans using the following code: + </p> + <p class='bcode'> + Swagger swagger = JsonParser.<jsf>DEFAULT</jsf>.parse(swaggerJson, Swagger.<jk>class</jk>); + </p> + </div> + +</div></div> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/dto/swagger/package-tree.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/package-tree.html b/content/site/apidocs/org/apache/juneau/dto/swagger/package-tree.html index 11d190a..0695792 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/package-tree.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/package-tree.html @@ -80,6 +80,9 @@ <ul> <li type="circle">java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Object</span></a> <ul> +<li type="circle">org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/SwaggerBuilder.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">SwaggerBuilder</span></a></li> +<li type="circle">org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">SwaggerElement</span></a> +<ul> <li type="circle">org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Contact</span></a></li> <li type="circle">org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">ExternalDocumentation</span></a></li> <li type="circle">org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">HeaderInfo</span></a></li> @@ -96,6 +99,9 @@ <li type="circle">org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Xml</span></a></li> </ul> </li> +<li type="circle">org.apache.juneau.dto.swagger.<a href="../../../../../org/apache/juneau/dto/swagger/Temp.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Temp</span></a></li> +</ul> +</li> </ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html index ca48e06..c02ea93 100644 --- a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html +++ b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html @@ -240,14 +240,14 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <!-- --> </a> <h3>Fields inherited from class org.apache.juneau.html.<a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" title="class in org.apache.juneau.html">HtmlSerializerContext</a></h3> -<code><a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_addKeyValueTableHeaders">HTML_addKeyValueTableHeaders</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_detectLinksInStrings">HTML_detectLinksInStrings</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_labelParameter">HTML_labelParameter</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_lookForLabelParameters">HTML_lookForLabelParameters</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_uriAnchorText">HTML_uriAnchorText</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#LAST_TOKEN">LAST_TOKEN</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#PROPERTY_NAME">PROPERTY_NAME</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#TO_STRING">TO_STRING</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerCon text.html#URI">URI</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#URI_ANCHOR">URI_ANCHOR</a></code></li> +<code><a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_addBeanTypeProperties">HTML_addBeanTypeProperties</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_addKeyValueTableHeaders">HTML_addKeyValueTableHeaders</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_detectLinksInStrings">HTML_detectLinksInStrings</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_labelParameter">HTML_labelParameter</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_lookForLabelParameters">HTML_lookForLabelParameters</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#HTML_uriAnchorText">HTML_uriAnchorText</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#LAST_TOKEN">LAST_TOKEN</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#PROPERTY_NAME">PROPERTY_NAME</a>, <a href="../../../../org/ap ache/juneau/html/HtmlSerializerContext.html#TO_STRING">TO_STRING</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#URI">URI</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html#URI_ANCHOR">URI_ANCHOR</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.xml.XmlSerializerContext"> <!-- --> </a> <h3>Fields inherited from class org.apache.juneau.xml.<a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html" title="class in org.apache.juneau.xml">XmlSerializerContext</a></h3> -<code><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addNamespaceUrisToRoot">XML_addNamespaceUrisToRoot</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_autoDetectNamespaces">XML_autoDetectNamespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_defaultNamespace">XML_defaultNamespace</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_enableNamespaces">XML_enableNamespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_namespaces">XML_namespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_xsNamespace">XML_xsNamespace</a></code></li> +<code><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addBeanTypeProperties">XML_addBeanTypeProperties</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addNamespaceUrisToRoot">XML_addNamespaceUrisToRoot</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_autoDetectNamespaces">XML_autoDetectNamespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_defaultNamespace">XML_defaultNamespace</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_enableNamespaces">XML_enableNamespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_namespaces">XML_namespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_xsNamespace">XML_xsNamespace</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.serializer.SerializerContext">
