| <!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>ResponseInfo (Apache Juneau 8.2.0)</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="ResponseInfo (Apache Juneau 8.2.0)"; |
| } |
| } |
| 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,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/ParameterInfo.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/SchemaInfo.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/ResponseInfo.html" target="_top">Frames</a></li> |
| <li><a href="ResponseInfo.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 ResponseInfo" class="title">Class ResponseInfo</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/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.ResponseInfo</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#bpi--">bpi</a>="description,schema,headers,x-example,examples,*") |
| public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.65">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 w800'> |
| <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 w800'> |
| <jc>// Output</jc> |
| { |
| <js>"description"</js>: <js>"A complex object array response"</js>, |
| <js>"schema"</js>: { |
| <js>"type"</js>: <js>"array"</js>, |
| <js>"items"</js>: { |
| <js>"$ref"</js>: <js>"#/definitions/VeryComplexType"</js> |
| } |
| } |
| } |
| </p> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-dto.DtoSwagger'>Overview > juneau-dto > Swagger</a> |
| </ul></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/ResponseInfo.html#ResponseInfo--">ResponseInfo</a></span>()</code> |
| <div class="block">Default constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#ResponseInfo-org.apache.juneau.dto.swagger.ResponseInfo-">ResponseInfo</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> copyFrom)</code> |
| <div class="block">Copy constructor.</div> |
| </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="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><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#addExamples-java.util.Map-">addExamples</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/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#addHeaders-java.util.Map-">addHeaders</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/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#copy--">copy</a></span>()</code> |
| <div class="block">Make a deep copy of this object.</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#copyFrom-org.apache.juneau.dto.swagger.ResponseInfo-">copyFrom</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> r)</code> |
| <div class="block">Copies any non-null fields from the specified object to this object.</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#description-java.lang.Object-">description</a></span>(<a href="https://docs.oracle.com/javase/8/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="i5" 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.Object-">example</a></span>(<a href="https://docs.oracle.com/javase/8/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>x-example</property>.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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#example-java.lang.String-java.lang.Object-">example</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mimeType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> example)</code> |
| <div class="block">Adds a single value to the <property>examples</property> property.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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#examples-java.lang.Object...-">examples</a></span>(<a href="https://docs.oracle.com/javase/8/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="i8" class="altColor"> |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/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="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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#getExample--">getExample</a></span>()</code> |
| <div class="block">Bean property getter: <property>x-example</property>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/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="i12" class="altColor"> |
| <td class="colFirst"><code><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#getHeader-java.lang.String-">getHeader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Returns the header information with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/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="i14" class="altColor"> |
| <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="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html#hasHeaders--">hasHeaders</a></span>()</code> |
| <div class="block">Returns <jk>true</jk> if this response info has headers associated with it.</div> |
| </td> |
| </tr> |
| <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#header-java.lang.String-org.apache.juneau.dto.swagger.HeaderInfo-">header</a></span>(<a href="https://docs.oracle.com/javase/8/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">Adds a single value to the <property>headers</property> property.</div> |
| </td> |
| </tr> |
| <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#headers-java.lang.Object...-">headers</a></span>(<a href="https://docs.oracle.com/javase/8/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="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/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#keySet--">keySet</a></span>()</code> |
| <div class="block">Returns all the keys on this element.</div> |
| </td> |
| </tr> |
| <tr id="i19" 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#resolveRefs-org.apache.juneau.dto.swagger.Swagger-java.util.Deque-int-">resolveRefs</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> swagger, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Deque.html?is-external=true" title="class or interface in java.util">Deque</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> refStack, |
| int maxDepth)</code> |
| <div class="block">Resolves any <js>"$ref"</js> attributes in this element.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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="https://docs.oracle.com/javase/8/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="i21" 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#set-java.lang.String-java.lang.Object-">set</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/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="i22" 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="https://docs.oracle.com/javase/8/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="i23" 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#setExample-java.lang.Object-">setExample</a></span>(<a href="https://docs.oracle.com/javase/8/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>x-example</property>.</div> |
| </td> |
| </tr> |
| <tr id="i24" 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#setExamples-java.util.Map-">setExamples</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/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="i25" 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#setHeaders-java.util.Map-">setHeaders</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/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="i26" 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#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> |
| </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#asMap--">asMap</a>, <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#extraKeys--">extraKeys</a>, <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#get-java.lang.String-">get</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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="ResponseInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ResponseInfo</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.76">ResponseInfo</a>()</pre> |
| <div class="block">Default constructor.</div> |
| </li> |
| </ul> |
| <a name="ResponseInfo-org.apache.juneau.dto.swagger.ResponseInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ResponseInfo</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.83">ResponseInfo</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> copyFrom)</pre> |
| <div class="block">Copy constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>copyFrom</code> - The object to copy.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="copy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</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.110">copy</a>()</pre> |
| <div class="block">Make a deep copy of this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A deep copy of this object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFrom-org.apache.juneau.dto.swagger.ResponseInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFrom</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.122">copyFrom</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> r)</pre> |
| <div class="block">Copies any non-null fields from the specified object to this object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>r</code> - The object to copy fields from. |
| <br>Can be <jk>null</jk>.</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="https://docs.oracle.com/javase/8/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.146">getDescription</a>()</pre> |
| <div class="block">Bean property getter: <property>description</property>. |
| |
| <p> |
| A short description of the response.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDescription-java.lang.String-"> |
| <!-- --> |
| </a> |
| <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.162">setDescription</a>(<a href="https://docs.oracle.com/javase/8/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> |
| A short description of the response.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <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.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.176">description</a>(<a href="https://docs.oracle.com/javase/8/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>value</code> - The new value for this property. |
| <br>Non-String values will be converted to String using <c>toString()</c>. |
| <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="getSchema--"> |
| <!-- --> |
| </a> |
| <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.198">getSchema</a>()</pre> |
| <div class="block">Bean property getter: <property>schema</property>. |
| |
| <p> |
| A definition of the response structure. |
| |
| <ul class='notes'> |
| <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='https://swagger.io/specification/v2#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 property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSchema-org.apache.juneau.dto.swagger.SchemaInfo-"> |
| <!-- --> |
| </a> |
| <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.224">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. |
| |
| <ul class='notes'> |
| <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='https://swagger.io/specification/v2#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>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-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.246">schema</a>(<a href="https://docs.oracle.com/javase/8/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>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><c>String</c> - 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> |
| <p class='bcode w800'> |
| <jc>// Example </jc> |
| 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> |
| </li> |
| </ul> |
| <a name="getHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/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.258">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 property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeaders-java.util.Map-"> |
| <!-- --> |
| </a> |
| <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.273">setHeaders</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/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>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="addHeaders-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <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.286">addHeaders</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/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>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> |
| </li> |
| </ul> |
| <a name="header-java.lang.String-org.apache.juneau.dto.swagger.HeaderInfo-"> |
| <!-- --> |
| </a> |
| <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.298">header</a>(<a href="https://docs.oracle.com/javase/8/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">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> |
| <dd><code>header</code> - The header descriptions</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object (for method chaining).</dd> |
| </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.320">headers</a>(<a href="https://docs.oracle.com/javase/8/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><c>Map<String,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger"><code>HeaderInfo</code></a>|String></c> |
| <li><c>String</c> - JSON object representation of <c>Map<String,<a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger"><code>HeaderInfo</code></a>></c> |
| <p class='bcode w800'> |
| <jc>// Example </jc> |
| 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="getHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeader</h4> |
| <pre>public <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.331">getHeader</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Returns the header information with the specified name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The header name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The header info, or <jk>null</jk> if not found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExample--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExample</h4> |
| <pre><a href="../../../../../org/apache/juneau/annotation/Beanp.html" title="annotation in org.apache.juneau.annotation">@Beanp</a>(<a href="../../../../../org/apache/juneau/annotation/Beanp.html#value--">value</a>="x-example") |
| public <a href="https://docs.oracle.com/javase/8/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.341">getExample</a>()</pre> |
| <div class="block">Bean property getter: <property>x-example</property>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExample-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExample</h4> |
| <pre><a href="../../../../../org/apache/juneau/annotation/Beanp.html" title="annotation in org.apache.juneau.annotation">@Beanp</a>(<a href="../../../../../org/apache/juneau/annotation/Beanp.html#value--">value</a>="x-example") |
| 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.354">setExample</a>(<a href="https://docs.oracle.com/javase/8/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>x-example</property>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <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="example-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <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.365">example</a>(<a href="https://docs.oracle.com/javase/8/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>x-example</property>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - The property value.</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="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/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.378">getExamples</a>()</pre> |
| <div class="block">Bean property getter: <property>examples</property>. |
| |
| <p> |
| An example of the response message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The property value, or <jk>null</jk> if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExamples-java.util.Map-"> |
| <!-- --> |
| </a> |
| <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.394">setExamples</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <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="addExamples-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <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.407">addExamples</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/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>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="example-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <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.419">example</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mimeType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> example)</pre> |
| <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 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.lang.Object...-"> |
| <!-- --> |
| </a> |
| <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.441">examples</a>(<a href="https://docs.oracle.com/javase/8/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><c>Map<String,Object></c> |
| <li><c>String</c> - JSON object representation of <c>Map<String,Object></c> |
| <p class='bcode w800'> |
| <jc>// Example </jc> |
| 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.447">get</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/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="blockList"> |
| <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.461">set</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/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>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> |
| </li> |
| </ul> |
| <a name="keySet--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keySet</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/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.477">keySet</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#keySet--">SwaggerElement</a></code></span></div> |
| <div class="block">Returns all the keys on this element.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#keySet--">keySet</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="returnLabel">Returns:</span></dt> |
| <dd>All the keys on this element. |
| <br>Never <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasHeaders</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ResponseInfo.html#line.492">hasHeaders</a>()</pre> |
| <div class="block">Returns <jk>true</jk> if this response info has headers associated with it.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><jk>true</jk> if this response info has headers associated with it.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveRefs-org.apache.juneau.dto.swagger.Swagger-java.util.Deque-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resolveRefs</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.509">resolveRefs</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> swagger, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Deque.html?is-external=true" title="class or interface in java.util">Deque</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> refStack, |
| int maxDepth)</pre> |
| <div class="block">Resolves any <js>"$ref"</js> attributes in this element.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>swagger</code> - The swagger document containing the definitions.</dd> |
| <dd><code>refStack</code> - Keeps track of previously-visited references so that we don't cause recursive loops.</dd> |
| <dd><code>maxDepth</code> - The maximum depth to resolve references. |
| <br>After that level is reached, <c>$ref</c> references will be left alone. |
| <br>Useful if you have very complex models and you don't want your swagger page to be overly-complex.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object with references resolved. |
| <br>May or may not be the same object.</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/ParameterInfo.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/SchemaInfo.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/ResponseInfo.html" target="_top">Frames</a></li> |
| <li><a href="ResponseInfo.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 © 2016–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
