You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/02 15:32:24 UTC
[23/51] [partial] incubator-juneau-website git commit: Javadoc
updates.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/dto/swagger/ResponseInfo.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/ResponseInfo.html b/content/site/apidocs/org/apache/juneau/dto/swagger/ResponseInfo.html
index 1e7ce18..c060006 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/ResponseInfo.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/ResponseInfo.html
@@ -114,7 +114,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre><a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a>="description,schema,headers,examples")
-public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.39">ResponseInfo</a>
+public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.46">ResponseInfo</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">Describes a single response from an API Operation.
@@ -130,8 +130,15 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
}
}
</p>
- <p>
- Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a> for usage information.</div>
+
+ <h6 class='topic'>Additional Information</h6>
+ <ul class='doctree'>
+ <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ <ul>
+ <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ </ul>
+ <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ </ul></div>
</li>
</ul>
</div>
@@ -296,7 +303,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>ResponseInfo</h4>
-<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.39">ResponseInfo</a>()</pre>
+<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.46">ResponseInfo</a>()</pre>
</li>
</ul>
</li>
@@ -313,7 +320,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.54">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/ResponseInfo.html#line.61">getDescription</a>()</pre>
<div class="block">Bean property getter: <property>description</property>.
<p>
Required. A short description of the response.
@@ -330,7 +337,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.67">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/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.74">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>
Required. A short description of the response.
@@ -349,7 +356,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.78">description</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.85">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/ResponseInfo.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -365,7 +372,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.93">getSchema</a>()</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.100">getSchema</a>()</pre>
<div class="block">Bean property getter: <property>schema</property>.
<p>
A definition of the response structure.
@@ -385,7 +392,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setSchema</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.109">setSchema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.116">setSchema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre>
<div class="block">Bean property setter: <property>schema</property>.
<p>
A definition of the response structure.
@@ -407,7 +414,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.120">schema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.127">schema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setSchema-org.apache.juneau.dto.swagger.SchemaInfo-"><code>setSchema(SchemaInfo)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -423,7 +430,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getHeaders</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.131">getHeaders</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.138">getHeaders</a>()</pre>
<div class="block">Bean property getter: <property>headers</property>.
<p>
A list of headers that are sent with the response.</div>
@@ -439,7 +446,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setHeaders</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.143">setHeaders</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a>> headers)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.150">setHeaders</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a>> headers)</pre>
<div class="block">Bean property setter: <property>headers</property>.
<p>
A list of headers that are sent with the response.</div>
@@ -457,7 +464,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>addHeader</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.157">addHeader</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>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.164">addHeader</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,
<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a> header)</pre>
<div class="block">Bean property adder: <property>headers</property>.
<p>
@@ -477,7 +484,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.171">header</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>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.178">header</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,
<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a> header)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#addHeader-java.lang.String-org.apache.juneau.dto.swagger.HeaderInfo-"><code>addHeader(String,HeaderInfo)</code></a>.</div>
<dl>
@@ -495,7 +502,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getExamples</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.183">getExamples</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.190">getExamples</a>()</pre>
<div class="block">Bean property getter: <property>examples</property>.
<p>
An example of the response message.
@@ -512,7 +519,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setExamples</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.196">setExamples</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> examples)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.203">setExamples</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> examples)</pre>
<div class="block">Bean property setter: <property>examples</property>.
<p>
An example of the response message.
@@ -531,7 +538,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>addExample</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.210">addExample</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> mimeType,
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.217">addExample</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> mimeType,
<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> example)</pre>
<div class="block">Bean property adder: <property>examples</property>.
<p>
@@ -551,7 +558,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>example</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.224">example</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> mimeType,
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.231">example</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> mimeType,
<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> example)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#addExample-java.lang.String-java.lang.Object-"><code>addExample(String,Object)</code></a>.</div>
<dl>
@@ -569,7 +576,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>examples</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.234">examples</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> examples)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.241">examples</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> examples)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setExamples-java.util.Map-"><code>setExamples(Map)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>