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 2018/01/18 19:35:00 UTC
[24/33] juneau-website git commit: Update javadocs.
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/60d9bd65/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 71710cc..2f6c1c8 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/ResponseInfo.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/ResponseInfo.html
@@ -18,7 +18,7 @@
catch(err) {
}
//-->
-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 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,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -113,13 +113,32 @@ var activeTableTab = "activeTableTab";
<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>="description,schema,headers,examples")
-public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.51">ResponseInfo</a>
+<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.61">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.
<h5 class='section'>Example:</h5>
<p class='bcode'>
+ <jc>// Construct using SwaggerBuilder.</jc>
+ ResponseInfo x = <jsm>responseInfo</jsm>(<js>"A complex object array response"</js>)
+ .schema(
+ <jsm>schemaInfo</jsm>
+ .type(<js>"array"</js>)
+ .items(
+ <jsm>items<jsm>()
+ .set(<js>"$ref"</js>, <js>"#/definitions/VeryComplexType"</js>)
+ )
+ );
+
+ <jc>// Serialize using JsonSerializer.</jc>
+ String json = JsonSerializer.<jsf>DEFAULT</jsf>.toString(x);
+
+ <jc>// Or just use toString() which does the same as above.</jc>
+ String json = x.toString();
+ </p>
+ <p class='bcode'>
+ <jc>// Output</jc>
{
<js>"description"</js>: <js>"A complex object array response"</js>,
<js>"schema"</js>: {
@@ -133,17 +152,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='link'>
- <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
- (org.apache.juneau.dto)</a>
- <ul>
- <li class='sublink'>
- <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- </ul>
- </li>
- <li class='jp'>
- <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
- </li>
+ <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-dto.Swagger'>Overview > juneau-dto > Swagger</a>
</ul></div>
</li>
</ul>
@@ -182,95 +191,113 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#addExample-java.lang.String-java.lang.Object-">addExample</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> 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)</code>
-<div class="block">Bean property adder: <property>examples</property>.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#addExamples-java.util.Map-">addExamples</a></span>(<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>> values)</code>
+<div class="block">Adds one or more values to the <property>examples</property> property.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#addHeader-java.lang.String-org.apache.juneau.dto.swagger.HeaderInfo-">addHeader</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,
- <a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a> header)</code>
-<div class="block">Bean property adder: <property>headers</property>.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#addHeaders-java.util.Map-">addHeaders</a></span>(<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>> values)</code>
+<div class="block">Adds one or more values to the <property>headers</property> property.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.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/ResponseInfo.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#description-java.lang.Object-">description</a></span>(<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> value)</code>
+<div class="block">Same as <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#example-java.lang.String-java.lang.Object-">example</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> 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)</code>
-<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>
+<div class="block">Adds a single value to the <property>examples</property> property.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#examples-java.util.Map-">examples</a></span>(<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)</code>
-<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setExamples-java.util.Map-"><code>setExamples(Map)</code></a>.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#examples-java.lang.Object...-">examples</a></span>(<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>... values)</code>
+<div class="block">Adds one or more values to the <property>examples</property> property.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
+<td class="colFirst"><code><T> T</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#get-java.lang.String-java.lang.Class-">get</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> property,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code>
+<div class="block">Generic property getter.</div>
+</td>
+</tr>
+<tr id="i6" 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/ResponseInfo.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Bean property getter: <property>description</property>.</div>
</td>
</tr>
-<tr id="i6" class="altColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code><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>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#getExamples--">getExamples</a></span>()</code>
<div class="block">Bean property getter: <property>examples</property>.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code><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>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#getHeaders--">getHeaders</a></span>()</code>
<div class="block">Bean property getter: <property>headers</property>.</div>
</td>
</tr>
-<tr id="i8" class="altColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#getSchema--">getSchema</a></span>()</code>
<div class="block">Bean property getter: <property>schema</property>.</div>
</td>
</tr>
-<tr id="i9" class="rowColor">
+<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#header-java.lang.String-org.apache.juneau.dto.swagger.HeaderInfo-">header</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,
<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a> header)</code>
-<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>
+<div class="block">Adds a single value to the <property>headers</property> property.</div>
</td>
</tr>
-<tr id="i10" class="altColor">
+<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#schema-org.apache.juneau.dto.swagger.SchemaInfo-">schema</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</code>
-<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>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#headers-java.lang.Object...-">headers</a></span>(<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>... values)</code>
+<div class="block">Adds one or more values to the <property>headers</property> property.</div>
</td>
</tr>
-<tr id="i11" class="rowColor">
+<tr id="i12" class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#schema-java.lang.Object-">schema</a></span>(<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> value)</code>
+<div class="block">Same as <a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setSchema-org.apache.juneau.dto.swagger.SchemaInfo-"><code>setSchema(SchemaInfo)</code></a>.</div>
+</td>
+</tr>
+<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.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>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#set-java.lang.String-java.lang.Object-">set</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> property,
+ <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> value)</code>
+<div class="block">Generic property setter.</div>
+</td>
+</tr>
+<tr id="i14" class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.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> value)</code>
<div class="block">Bean property setter: <property>description</property>.</div>
</td>
</tr>
-<tr id="i12" class="altColor">
+<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setExamples-java.util.Map-">setExamples</a></span>(<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)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setExamples-java.util.Map-">setExamples</a></span>(<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>> value)</code>
<div class="block">Bean property setter: <property>examples</property>.</div>
</td>
</tr>
-<tr id="i13" class="rowColor">
+<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setHeaders-java.util.Map-">setHeaders</a></span>(<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)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setHeaders-java.util.Map-">setHeaders</a></span>(<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>> value)</code>
<div class="block">Bean property setter: <property>headers</property>.</div>
</td>
</tr>
-<tr id="i14" class="altColor">
+<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setSchema-org.apache.juneau.dto.swagger.SchemaInfo-">setSchema</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#setSchema-org.apache.juneau.dto.swagger.SchemaInfo-">setSchema</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> value)</code>
<div class="block">Bean property setter: <property>schema</property>.</div>
</td>
</tr>
@@ -280,14 +307,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<!-- -->
</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>
+<code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#getExtraProperties--">getExtraProperties</a>, <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#isStrict--">isStrict</a>, <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#strict--">strict</a>, <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#strict-java.lang.Object-">strict</a>, <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#toString--">toString</a></code></li>
</ul>
<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>
+<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#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>
@@ -309,7 +336,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.51">ResponseInfo</a>()</pre>
+<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.61">ResponseInfo</a>()</pre>
</li>
</ul>
</li>
@@ -326,18 +353,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
-<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.70">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.76">getDescription</a>()</pre>
<div class="block">Bean property getter: <property>description</property>.
<p>
- Required. A short description of the response.
-
- <p>
- <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for
- rich text representation.</div>
+ A short description of the response.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The property value, or <jk>null</jk> if it is not set.</dd>
</dl>
</li>
</ul>
@@ -347,34 +370,34 @@ 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.87">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.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> value)</pre>
<div class="block">Bean property setter: <property>description</property>.
<p>
- Required. A short description of the response.
-
- <p>
- <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
- for rich text representation.</div>
+ A short description of the response.</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>
+<dd><code>value</code> - The new value for this property.
+ <br><a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ <br>Property value is required.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
</li>
</ul>
-<a name="description-java.lang.String-">
+<a name="description-java.lang.Object-">
<!-- -->
</a>
<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.98">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>
+<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.106">description</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> value)</pre>
+<div class="block">Same as <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>
-<dd><code>description</code> - The new value for the <property>description</property> property on this bean.</dd>
+<dd><code>value</code> - The new value for this property.
+ <br>Non-String values will be converted to String using <code>toString()</code>.
+ <br>Can be <jk>null</jk> to unset the property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
@@ -386,21 +409,22 @@ 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.117">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.126">getSchema</a>()</pre>
<div class="block">Bean property getter: <property>schema</property>.
<p>
A definition of the response structure.
- <p>
- It can be a primitive, an array or an object.
- If this field does not exist, it means no content is returned as part of the response.
- As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
- its root type value may also be <js>"file"</js>.
- This SHOULD be accompanied by a relevant produces mime-type.</div>
+ <h5 class='section'>Notes:</h5>
+ <ul>
+ <li>If this field does not exist, it means no content is returned as part of the response.
+ <li>As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
+ its root type value may also be <js>"file"</js>.
+ <li>This SHOULD be accompanied by a relevant produces mime-type.
+ </ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The property value, or <jk>null</jk> if it is not set.</dd>
</dl>
</li>
</ul>
@@ -410,37 +434,50 @@ 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.137">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.150">setSchema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> value)</pre>
<div class="block">Bean property setter: <property>schema</property>.
<p>
A definition of the response structure.
- <p>
- It can be a primitive, an array or an object.
- If this field does not exist, it means no content is returned as part of the response.
- As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
- its root type value may also be <js>"file"</js>.
- This SHOULD be accompanied by a relevant produces mime-type.</div>
+ <h5 class='section'>Notes:</h5>
+ <ul>
+ <li>If this field does not exist, it means no content is returned as part of the response.
+ <li>As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
+ its root type value may also be <js>"file"</js>.
+ <li>This SHOULD be accompanied by a relevant produces mime-type.
+ </ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>schema</code> - The new value for the <property>schema</property> property on this bean.</dd>
+<dd><code>value</code> - The new value for this property.
+ <br>It can be a primitive, an array or an object.
+ <br>Can be <jk>null</jk> to unset the property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
</li>
</ul>
-<a name="schema-org.apache.juneau.dto.swagger.SchemaInfo-">
+<a name="schema-java.lang.Object-">
<!-- -->
</a>
<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.148">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>
+<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.172">schema</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> value)</pre>
+<div class="block">Same as <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>
-<dd><code>schema</code> - The new value for the <property>schema</property> property on this bean.</dd>
+<dd><code>value</code> - The new value for this property.
+ <br>Valid types:
+ <ul>
+ <li><a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger"><code>SchemaInfo</code></a>
+ <li><code>String</code> - JSON object representation of <a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger"><code>SchemaInfo</code></a>
+ <h6 class='figure'>Example:</h6>
+ <p class='bcode'>
+ schema(<js>"{type:'type',description:'description',...}"</js>);
+ </p>
+ </ul>
+ <br>Can be <jk>null</jk> to unset the property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
@@ -452,14 +489,14 @@ 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.160">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.184">getHeaders</a>()</pre>
<div class="block">Bean property getter: <property>headers</property>.
<p>
A list of headers that are sent with the response.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>headers</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The property value, or <jk>null</jk> if it is not set.</dd>
</dl>
</li>
</ul>
@@ -469,35 +506,32 @@ 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.173">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.199">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>> value)</pre>
<div class="block">Bean property setter: <property>headers</property>.
<p>
A list of headers that are sent with the response.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>headers</code> - The new value for the <property>headers</property> property on this bean.</dd>
+<dd><code>value</code> - The new value for this property.
+ <br>Can be <jk>null</jk> to unset the property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
</li>
</ul>
-<a name="addHeader-java.lang.String-org.apache.juneau.dto.swagger.HeaderInfo-">
+<a name="addHeaders-java.util.Map-">
<!-- -->
</a>
<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.188">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>
- A list of headers that are sent with the response.</div>
+<h4>addHeaders</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.212">addHeaders</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>> values)</pre>
+<div class="block">Adds one or more values to the <property>headers</property> property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>name</code> - The header name.</dd>
-<dd><code>header</code> - The header descriptions</dd>
+<dd><code>values</code> - The values to add to this property.
+ <br>Ignored if <jk>null</jk>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
@@ -509,9 +543,9 @@ 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.202">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.224">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>
+<div class="block">Adds a single value to the <property>headers</property> property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
@@ -521,23 +555,46 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
</dl>
</li>
</ul>
+<a name="headers-java.lang.Object...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>headers</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.246">headers</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>... values)</pre>
+<div class="block">Adds one or more values to the <property>headers</property> property.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>values</code> - The values to add to this property.
+ <br>Valid types:
+ <ul>
+ <li><code>Map<String,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger"><code>HeaderInfo</code></a>|String></code>
+ <li><code>String</code> - JSON object representation of <code>Map<String,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger"><code>HeaderInfo</code></a>></code>
+ <h6 class='figure'>Example:</h6>
+ <p class='bcode'>
+ headers(<js>"{headerName:{description:'description',...}}"</js>);
+ </p>
+ </ul>
+ <br>Ignored if <jk>null</jk>.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
<a name="getExamples--">
<!-- -->
</a>
<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.217">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.259">getExamples</a>()</pre>
<div class="block">Bean property getter: <property>examples</property>.
<p>
- An example of the response message.
-
- <p>
- Keys must be MIME-type strings.</div>
+ An example of the response message.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>examples</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The property value, or <jk>null</jk> if it is not set.</dd>
</dl>
</li>
</ul>
@@ -547,38 +604,33 @@ 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.233">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.275">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>> value)</pre>
<div class="block">Bean property setter: <property>examples</property>.
<p>
- An example of the response message.
-
- <p>
- Keys must be MIME-type strings.</div>
+ An example of the response message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>examples</code> - The new value for the <property>examples</property> property on this bean.</dd>
+<dd><code>value</code> - The new value for this property.
+ <br>Keys must be MIME-type strings.
+ <br>Can be <jk>null</jk> to unset the property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
</li>
</ul>
-<a name="addExample-java.lang.String-java.lang.Object-">
+<a name="addExamples-java.util.Map-">
<!-- -->
</a>
<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.248">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>
- An example of the response message.</div>
+<h4>addExamples</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.288">addExamples</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>> values)</pre>
+<div class="block">Adds one or more values to the <property>examples</property> property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>mimeType</code> - The mimeType of the example.</dd>
-<dd><code>example</code> - The example output.</dd>
+<dd><code>values</code> - The values to add to this property.
+ <br>Ignored if <jk>null</jk>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
@@ -590,29 +642,87 @@ 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.262">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.300">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>
+<div class="block">Adds a single value to the <property>examples</property> property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>mimeType</code> - The mimeType of the example.</dd>
-<dd><code>example</code> - The example output.</dd>
+<dd><code>mimeType</code> - The mime-type string.</dd>
+<dd><code>example</code> - The example.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
</li>
</ul>
-<a name="examples-java.util.Map-">
+<a name="examples-java.lang.Object...-">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<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.272">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>
+<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.322">examples</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>... values)</pre>
+<div class="block">Adds one or more values to the <property>examples</property> property.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>values</code> - The values to add to this property.
+ <br>Valid types:
+ <ul>
+ <li><code>Map<String,Object></code>
+ <li><code>String</code> - JSON object representation of <code>Map<String,Object></code>
+ <h6 class='figure'>Example:</h6>
+ <p class='bcode'>
+ examples(<js>"{'text/json':{foo:'bar'}}"</js>);
+ </p>
+ </ul>
+ <br>Ignored if <jk>null</jk>.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="get-java.lang.String-java.lang.Class-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>get</h4>
+<pre>public <T> T <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.328">get</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> property,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#get-java.lang.String-java.lang.Class-">SwaggerElement</a></code></span></div>
+<div class="block">Generic property getter.
+
+ <p>
+ Can be used to retrieve non-standard Swagger fields such as <js>"$ref"</js>.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#get-java.lang.String-java.lang.Class-">get</a></code> in class <code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>property</code> - The property name to retrieve.</dd>
+<dd><code>type</code> - The datatype to cast the value to.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The property value, or <jk>null</jk> if the property does not exist or is not set.</dd>
+</dl>
+</li>
+</ul>
+<a name="set-java.lang.String-java.lang.Object-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>set</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.341">set</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> property,
+ <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> value)</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#set-java.lang.String-java.lang.Object-">SwaggerElement</a></code></span></div>
+<div class="block">Generic property setter.
+
+ <p>
+ Can be used to set non-standard Swagger fields such as <js>"$ref"</js>.</div>
<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#set-java.lang.String-java.lang.Object-">set</a></code> in class <code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>examples</code> - The new value for the <property>examples</property> property on this bean.</dd>
+<dd><code>property</code> - The property name to set.</dd>
+<dd><code>value</code> - The new value for the property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>