| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.juneau.dto.swagger, class: ResponseInfo"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">002</span><span id="line-2">// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *</span> |
| <span class="source-line-no">003</span><span id="line-3">// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *</span> |
| <span class="source-line-no">004</span><span id="line-4">// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *</span> |
| <span class="source-line-no">005</span><span id="line-5">// * with the License. You may obtain a copy of the License at *</span> |
| <span class="source-line-no">006</span><span id="line-6">// * *</span> |
| <span class="source-line-no">007</span><span id="line-7">// * http://www.apache.org/licenses/LICENSE-2.0 *</span> |
| <span class="source-line-no">008</span><span id="line-8">// * *</span> |
| <span class="source-line-no">009</span><span id="line-9">// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *</span> |
| <span class="source-line-no">010</span><span id="line-10">// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *</span> |
| <span class="source-line-no">011</span><span id="line-11">// * specific language governing permissions and limitations under the License. *</span> |
| <span class="source-line-no">012</span><span id="line-12">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">013</span><span id="line-13">package org.apache.juneau.dto.swagger;</span> |
| <span class="source-line-no">014</span><span id="line-14"></span> |
| <span class="source-line-no">015</span><span id="line-15">import static org.apache.juneau.common.internal.StringUtils.*;</span> |
| <span class="source-line-no">016</span><span id="line-16">import static org.apache.juneau.internal.CollectionUtils.*;</span> |
| <span class="source-line-no">017</span><span id="line-17">import static org.apache.juneau.internal.ConverterUtils.*;</span> |
| <span class="source-line-no">018</span><span id="line-18"></span> |
| <span class="source-line-no">019</span><span id="line-19">import java.util.*;</span> |
| <span class="source-line-no">020</span><span id="line-20"></span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.juneau.annotation.*;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.juneau.internal.*;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">/**</span> |
| <span class="source-line-no">025</span><span id="line-25"> * Describes a single response from an API Operation.</span> |
| <span class="source-line-no">026</span><span id="line-26"> *</span> |
| <span class="source-line-no">027</span><span id="line-27"> * <h5 class='section'>Example:</h5></span> |
| <span class="source-line-no">028</span><span id="line-28"> * <p class='bjava'></span> |
| <span class="source-line-no">029</span><span id="line-29"> * <jc>// Construct using SwaggerBuilder.</jc></span> |
| <span class="source-line-no">030</span><span id="line-30"> * ResponseInfo <jv>info</jv> = <jsm>responseInfo</jsm>(<js>"A complex object array response"</js>)</span> |
| <span class="source-line-no">031</span><span id="line-31"> * .schema(</span> |
| <span class="source-line-no">032</span><span id="line-32"> * <jsm>schemaInfo</jsm></span> |
| <span class="source-line-no">033</span><span id="line-33"> * .type(<js>"array"</js>)</span> |
| <span class="source-line-no">034</span><span id="line-34"> * .items(</span> |
| <span class="source-line-no">035</span><span id="line-35"> * <jsm>items</jsm>()</span> |
| <span class="source-line-no">036</span><span id="line-36"> * .set(<js>"$ref"</js>, <js>"#/definitions/VeryComplexType"</js>)</span> |
| <span class="source-line-no">037</span><span id="line-37"> * )</span> |
| <span class="source-line-no">038</span><span id="line-38"> * );</span> |
| <span class="source-line-no">039</span><span id="line-39"> *</span> |
| <span class="source-line-no">040</span><span id="line-40"> * <jc>// Serialize using JsonSerializer.</jc></span> |
| <span class="source-line-no">041</span><span id="line-41"> * String <jv>json</jv> = JsonSerializer.<jsf>DEFAULT</jsf>.toString(<jv>info</jv>);</span> |
| <span class="source-line-no">042</span><span id="line-42"> *</span> |
| <span class="source-line-no">043</span><span id="line-43"> * <jc>// Or just use toString() which does the same as above.</jc></span> |
| <span class="source-line-no">044</span><span id="line-44"> * <jv>json</jv> = <jv>info</jv>.toString();</span> |
| <span class="source-line-no">045</span><span id="line-45"> * </p></span> |
| <span class="source-line-no">046</span><span id="line-46"> * <p class='bjson'></span> |
| <span class="source-line-no">047</span><span id="line-47"> * <jc>// Output</jc></span> |
| <span class="source-line-no">048</span><span id="line-48"> * {</span> |
| <span class="source-line-no">049</span><span id="line-49"> * <js>"description"</js>: <js>"A complex object array response"</js>,</span> |
| <span class="source-line-no">050</span><span id="line-50"> * <js>"schema"</js>: {</span> |
| <span class="source-line-no">051</span><span id="line-51"> * <js>"type"</js>: <js>"array"</js>,</span> |
| <span class="source-line-no">052</span><span id="line-52"> * <js>"items"</js>: {</span> |
| <span class="source-line-no">053</span><span id="line-53"> * <js>"$ref"</js>: <js>"#/definitions/VeryComplexType"</js></span> |
| <span class="source-line-no">054</span><span id="line-54"> * }</span> |
| <span class="source-line-no">055</span><span id="line-55"> * }</span> |
| <span class="source-line-no">056</span><span id="line-56"> * }</span> |
| <span class="source-line-no">057</span><span id="line-57"> * </p></span> |
| <span class="source-line-no">058</span><span id="line-58"> *</span> |
| <span class="source-line-no">059</span><span id="line-59"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">060</span><span id="line-60"> * <li class='link'><a class="doclink" href="../../../../../index.html#jrs.Swagger">Overview &gt; juneau-rest-server &gt; Swagger</a></span> |
| <span class="source-line-no">061</span><span id="line-61"> * </ul></span> |
| <span class="source-line-no">062</span><span id="line-62"> */</span> |
| <span class="source-line-no">063</span><span id="line-63">@Bean(properties="description,schema,headers,examples,*")</span> |
| <span class="source-line-no">064</span><span id="line-64">@FluentSetters</span> |
| <span class="source-line-no">065</span><span id="line-65">public class ResponseInfo extends SwaggerElement {</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> private String description;</span> |
| <span class="source-line-no">068</span><span id="line-68"> private SchemaInfo schema;</span> |
| <span class="source-line-no">069</span><span id="line-69"> private Map<String,HeaderInfo> headers;</span> |
| <span class="source-line-no">070</span><span id="line-70"> private Map<String,Object> examples;</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * Default constructor.</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> public ResponseInfo() {}</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * Copy constructor.</span> |
| <span class="source-line-no">079</span><span id="line-79"> *</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @param copyFrom The object to copy.</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> public ResponseInfo(ResponseInfo copyFrom) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> super(copyFrom);</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> this.description = copyFrom.description;</span> |
| <span class="source-line-no">086</span><span id="line-86"> this.schema = copyFrom.schema == null ? null : copyFrom.schema.copy();</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> this.examples = copyOf(copyFrom.examples);</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> if (copyFrom.headers == null) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> this.headers = null;</span> |
| <span class="source-line-no">092</span><span id="line-92"> } else {</span> |
| <span class="source-line-no">093</span><span id="line-93"> this.headers = map();</span> |
| <span class="source-line-no">094</span><span id="line-94"> copyFrom.headers.forEach((k,v) -> this.headers.put(k, v.copy()));</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /**</span> |
| <span class="source-line-no">100</span><span id="line-100"> * Make a deep copy of this object.</span> |
| <span class="source-line-no">101</span><span id="line-101"> *</span> |
| <span class="source-line-no">102</span><span id="line-102"> * @return A deep copy of this object.</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> public ResponseInfo copy() {</span> |
| <span class="source-line-no">105</span><span id="line-105"> return new ResponseInfo(this);</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /**</span> |
| <span class="source-line-no">109</span><span id="line-109"> * Copies any non-null fields from the specified object to this object.</span> |
| <span class="source-line-no">110</span><span id="line-110"> *</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @param r</span> |
| <span class="source-line-no">112</span><span id="line-112"> * The object to copy fields from.</span> |
| <span class="source-line-no">113</span><span id="line-113"> * <br>Can be <jk>null</jk>.</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @return This object.</span> |
| <span class="source-line-no">115</span><span id="line-115"> */</span> |
| <span class="source-line-no">116</span><span id="line-116"> public ResponseInfo copyFrom(ResponseInfo r) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> if (r != null) {</span> |
| <span class="source-line-no">118</span><span id="line-118"> if (r.description != null)</span> |
| <span class="source-line-no">119</span><span id="line-119"> description = r.description;</span> |
| <span class="source-line-no">120</span><span id="line-120"> if (r.schema != null)</span> |
| <span class="source-line-no">121</span><span id="line-121"> schema = r.schema;</span> |
| <span class="source-line-no">122</span><span id="line-122"> if (r.headers != null)</span> |
| <span class="source-line-no">123</span><span id="line-123"> headers = r.headers;</span> |
| <span class="source-line-no">124</span><span id="line-124"> if (r.examples != null)</span> |
| <span class="source-line-no">125</span><span id="line-125"> examples = r.examples;</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> return this;</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> //-----------------------------------------------------------------------------------------------------------------</span> |
| <span class="source-line-no">131</span><span id="line-131"> // Properties</span> |
| <span class="source-line-no">132</span><span id="line-132"> //-----------------------------------------------------------------------------------------------------------------</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> /**</span> |
| <span class="source-line-no">135</span><span id="line-135"> * Bean property getter: <property>description</property>.</span> |
| <span class="source-line-no">136</span><span id="line-136"> *</span> |
| <span class="source-line-no">137</span><span id="line-137"> * <p></span> |
| <span class="source-line-no">138</span><span id="line-138"> * A short description of the response.</span> |
| <span class="source-line-no">139</span><span id="line-139"> *</span> |
| <span class="source-line-no">140</span><span id="line-140"> * @return The property value, or <jk>null</jk> if it is not set.</span> |
| <span class="source-line-no">141</span><span id="line-141"> */</span> |
| <span class="source-line-no">142</span><span id="line-142"> public String getDescription() {</span> |
| <span class="source-line-no">143</span><span id="line-143"> return description;</span> |
| <span class="source-line-no">144</span><span id="line-144"> }</span> |
| <span class="source-line-no">145</span><span id="line-145"></span> |
| <span class="source-line-no">146</span><span id="line-146"> /**</span> |
| <span class="source-line-no">147</span><span id="line-147"> * Bean property setter: <property>description</property>.</span> |
| <span class="source-line-no">148</span><span id="line-148"> *</span> |
| <span class="source-line-no">149</span><span id="line-149"> * <p></span> |
| <span class="source-line-no">150</span><span id="line-150"> * A short description of the response.</span> |
| <span class="source-line-no">151</span><span id="line-151"> *</span> |
| <span class="source-line-no">152</span><span id="line-152"> * @param value</span> |
| <span class="source-line-no">153</span><span id="line-153"> * The new value for this property.</span> |
| <span class="source-line-no">154</span><span id="line-154"> * <br><a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.</span> |
| <span class="source-line-no">155</span><span id="line-155"> * <br>Property value is required.</span> |
| <span class="source-line-no">156</span><span id="line-156"> * @return This object.</span> |
| <span class="source-line-no">157</span><span id="line-157"> */</span> |
| <span class="source-line-no">158</span><span id="line-158"> public ResponseInfo setDescription(String value) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> description = value;</span> |
| <span class="source-line-no">160</span><span id="line-160"> return this;</span> |
| <span class="source-line-no">161</span><span id="line-161"> }</span> |
| <span class="source-line-no">162</span><span id="line-162"></span> |
| <span class="source-line-no">163</span><span id="line-163"> /**</span> |
| <span class="source-line-no">164</span><span id="line-164"> * Bean property getter: <property>examples</property>.</span> |
| <span class="source-line-no">165</span><span id="line-165"> *</span> |
| <span class="source-line-no">166</span><span id="line-166"> * <p></span> |
| <span class="source-line-no">167</span><span id="line-167"> * An example of the response message.</span> |
| <span class="source-line-no">168</span><span id="line-168"> *</span> |
| <span class="source-line-no">169</span><span id="line-169"> * @return The property value, or <jk>null</jk> if it is not set.</span> |
| <span class="source-line-no">170</span><span id="line-170"> */</span> |
| <span class="source-line-no">171</span><span id="line-171"> public Map<String,Object> getExamples() {</span> |
| <span class="source-line-no">172</span><span id="line-172"> return examples;</span> |
| <span class="source-line-no">173</span><span id="line-173"> }</span> |
| <span class="source-line-no">174</span><span id="line-174"></span> |
| <span class="source-line-no">175</span><span id="line-175"> /**</span> |
| <span class="source-line-no">176</span><span id="line-176"> * Bean property setter: <property>examples</property>.</span> |
| <span class="source-line-no">177</span><span id="line-177"> *</span> |
| <span class="source-line-no">178</span><span id="line-178"> * <p></span> |
| <span class="source-line-no">179</span><span id="line-179"> * An example of the response message.</span> |
| <span class="source-line-no">180</span><span id="line-180"> *</span> |
| <span class="source-line-no">181</span><span id="line-181"> * @param value</span> |
| <span class="source-line-no">182</span><span id="line-182"> * The new value for this property.</span> |
| <span class="source-line-no">183</span><span id="line-183"> * <br>Keys must be MIME-type strings.</span> |
| <span class="source-line-no">184</span><span id="line-184"> * <br>Can be <jk>null</jk> to unset the property.</span> |
| <span class="source-line-no">185</span><span id="line-185"> * @return This object.</span> |
| <span class="source-line-no">186</span><span id="line-186"> */</span> |
| <span class="source-line-no">187</span><span id="line-187"> public ResponseInfo setExamples(Map<String,Object> value) {</span> |
| <span class="source-line-no">188</span><span id="line-188"> examples = copyOf(value);</span> |
| <span class="source-line-no">189</span><span id="line-189"> return this;</span> |
| <span class="source-line-no">190</span><span id="line-190"> }</span> |
| <span class="source-line-no">191</span><span id="line-191"></span> |
| <span class="source-line-no">192</span><span id="line-192"> /**</span> |
| <span class="source-line-no">193</span><span id="line-193"> * Bean property appender: <property>examples</property>.</span> |
| <span class="source-line-no">194</span><span id="line-194"> *</span> |
| <span class="source-line-no">195</span><span id="line-195"> * <p></span> |
| <span class="source-line-no">196</span><span id="line-196"> * Adds a single value to the <property>examples</property> property.</span> |
| <span class="source-line-no">197</span><span id="line-197"> *</span> |
| <span class="source-line-no">198</span><span id="line-198"> * @param mimeType The mime-type string.</span> |
| <span class="source-line-no">199</span><span id="line-199"> * @param example The example.</span> |
| <span class="source-line-no">200</span><span id="line-200"> * @return This object.</span> |
| <span class="source-line-no">201</span><span id="line-201"> */</span> |
| <span class="source-line-no">202</span><span id="line-202"> public ResponseInfo addExample(String mimeType, Object example) {</span> |
| <span class="source-line-no">203</span><span id="line-203"> examples = mapBuilder(examples).sparse().add(mimeType, example).build();</span> |
| <span class="source-line-no">204</span><span id="line-204"> return this;</span> |
| <span class="source-line-no">205</span><span id="line-205"> }</span> |
| <span class="source-line-no">206</span><span id="line-206"></span> |
| <span class="source-line-no">207</span><span id="line-207"> /**</span> |
| <span class="source-line-no">208</span><span id="line-208"> * Bean property getter: <property>headers</property>.</span> |
| <span class="source-line-no">209</span><span id="line-209"> *</span> |
| <span class="source-line-no">210</span><span id="line-210"> * <p></span> |
| <span class="source-line-no">211</span><span id="line-211"> * A list of headers that are sent with the response.</span> |
| <span class="source-line-no">212</span><span id="line-212"> *</span> |
| <span class="source-line-no">213</span><span id="line-213"> * @return The property value, or <jk>null</jk> if it is not set.</span> |
| <span class="source-line-no">214</span><span id="line-214"> */</span> |
| <span class="source-line-no">215</span><span id="line-215"> public Map<String,HeaderInfo> getHeaders() {</span> |
| <span class="source-line-no">216</span><span id="line-216"> return headers;</span> |
| <span class="source-line-no">217</span><span id="line-217"> }</span> |
| <span class="source-line-no">218</span><span id="line-218"></span> |
| <span class="source-line-no">219</span><span id="line-219"> /**</span> |
| <span class="source-line-no">220</span><span id="line-220"> * Bean property setter: <property>headers</property>.</span> |
| <span class="source-line-no">221</span><span id="line-221"> *</span> |
| <span class="source-line-no">222</span><span id="line-222"> * <p></span> |
| <span class="source-line-no">223</span><span id="line-223"> * A list of headers that are sent with the response.</span> |
| <span class="source-line-no">224</span><span id="line-224"> *</span> |
| <span class="source-line-no">225</span><span id="line-225"> * @param value</span> |
| <span class="source-line-no">226</span><span id="line-226"> * The new value for this property.</span> |
| <span class="source-line-no">227</span><span id="line-227"> * <br>Can be <jk>null</jk> to unset the property.</span> |
| <span class="source-line-no">228</span><span id="line-228"> * @return This object.</span> |
| <span class="source-line-no">229</span><span id="line-229"> */</span> |
| <span class="source-line-no">230</span><span id="line-230"> public ResponseInfo setHeaders(Map<String,HeaderInfo> value) {</span> |
| <span class="source-line-no">231</span><span id="line-231"> headers = copyOf(value);</span> |
| <span class="source-line-no">232</span><span id="line-232"> return this;</span> |
| <span class="source-line-no">233</span><span id="line-233"> }</span> |
| <span class="source-line-no">234</span><span id="line-234"></span> |
| <span class="source-line-no">235</span><span id="line-235"> /**</span> |
| <span class="source-line-no">236</span><span id="line-236"> * Bean property appender: <property>headers</property>.</span> |
| <span class="source-line-no">237</span><span id="line-237"> *</span> |
| <span class="source-line-no">238</span><span id="line-238"> * @param name The header name.</span> |
| <span class="source-line-no">239</span><span id="line-239"> * @param header The header descriptions</span> |
| <span class="source-line-no">240</span><span id="line-240"> * @return This object.</span> |
| <span class="source-line-no">241</span><span id="line-241"> */</span> |
| <span class="source-line-no">242</span><span id="line-242"> public ResponseInfo addHeader(String name, HeaderInfo header) {</span> |
| <span class="source-line-no">243</span><span id="line-243"> headers = mapBuilder(headers).add(name, header).build();</span> |
| <span class="source-line-no">244</span><span id="line-244"> return this;</span> |
| <span class="source-line-no">245</span><span id="line-245"> }</span> |
| <span class="source-line-no">246</span><span id="line-246"></span> |
| <span class="source-line-no">247</span><span id="line-247"> /**</span> |
| <span class="source-line-no">248</span><span id="line-248"> * Returns the header information with the specified name.</span> |
| <span class="source-line-no">249</span><span id="line-249"> *</span> |
| <span class="source-line-no">250</span><span id="line-250"> * @param name The header name.</span> |
| <span class="source-line-no">251</span><span id="line-251"> * @return The header info, or <jk>null</jk> if not found.</span> |
| <span class="source-line-no">252</span><span id="line-252"> */</span> |
| <span class="source-line-no">253</span><span id="line-253"> public HeaderInfo getHeader(String name) {</span> |
| <span class="source-line-no">254</span><span id="line-254"> return getHeaders().get(name);</span> |
| <span class="source-line-no">255</span><span id="line-255"> }</span> |
| <span class="source-line-no">256</span><span id="line-256"></span> |
| <span class="source-line-no">257</span><span id="line-257"> /**</span> |
| <span class="source-line-no">258</span><span id="line-258"> * Bean property getter: <property>schema</property>.</span> |
| <span class="source-line-no">259</span><span id="line-259"> *</span> |
| <span class="source-line-no">260</span><span id="line-260"> * <p></span> |
| <span class="source-line-no">261</span><span id="line-261"> * A definition of the response structure.</span> |
| <span class="source-line-no">262</span><span id="line-262"> *</span> |
| <span class="source-line-no">263</span><span id="line-263"> * @return The property value, or <jk>null</jk> if it is not set.</span> |
| <span class="source-line-no">264</span><span id="line-264"> */</span> |
| <span class="source-line-no">265</span><span id="line-265"> public SchemaInfo getSchema() {</span> |
| <span class="source-line-no">266</span><span id="line-266"> return schema;</span> |
| <span class="source-line-no">267</span><span id="line-267"> }</span> |
| <span class="source-line-no">268</span><span id="line-268"></span> |
| <span class="source-line-no">269</span><span id="line-269"> /**</span> |
| <span class="source-line-no">270</span><span id="line-270"> * Bean property setter: <property>schema</property>.</span> |
| <span class="source-line-no">271</span><span id="line-271"> *</span> |
| <span class="source-line-no">272</span><span id="line-272"> * <p></span> |
| <span class="source-line-no">273</span><span id="line-273"> * A definition of the response structure.</span> |
| <span class="source-line-no">274</span><span id="line-274"> *</span> |
| <span class="source-line-no">275</span><span id="line-275"> * @param value</span> |
| <span class="source-line-no">276</span><span id="line-276"> * The new value for this property.</span> |
| <span class="source-line-no">277</span><span id="line-277"> * <br>It can be a primitive, an array or an object.</span> |
| <span class="source-line-no">278</span><span id="line-278"> * <br>Can be <jk>null</jk> to unset the property.</span> |
| <span class="source-line-no">279</span><span id="line-279"> * @return This object.</span> |
| <span class="source-line-no">280</span><span id="line-280"> */</span> |
| <span class="source-line-no">281</span><span id="line-281"> public ResponseInfo setSchema(SchemaInfo value) {</span> |
| <span class="source-line-no">282</span><span id="line-282"> schema = value;</span> |
| <span class="source-line-no">283</span><span id="line-283"> return this;</span> |
| <span class="source-line-no">284</span><span id="line-284"> }</span> |
| <span class="source-line-no">285</span><span id="line-285"></span> |
| <span class="source-line-no">286</span><span id="line-286"> // <FluentSetters></span> |
| <span class="source-line-no">287</span><span id="line-287"></span> |
| <span class="source-line-no">288</span><span id="line-288"> // </FluentSetters></span> |
| <span class="source-line-no">289</span><span id="line-289"></span> |
| <span class="source-line-no">290</span><span id="line-290"> @Override /* SwaggerElement */</span> |
| <span class="source-line-no">291</span><span id="line-291"> public <T> T get(String property, Class<T> type) {</span> |
| <span class="source-line-no">292</span><span id="line-292"> if (property == null)</span> |
| <span class="source-line-no">293</span><span id="line-293"> return null;</span> |
| <span class="source-line-no">294</span><span id="line-294"> switch (property) {</span> |
| <span class="source-line-no">295</span><span id="line-295"> case "description": return toType(getDescription(), type);</span> |
| <span class="source-line-no">296</span><span id="line-296"> case "examples": return toType(getExamples(), type);</span> |
| <span class="source-line-no">297</span><span id="line-297"> case "headers": return toType(getHeaders(), type);</span> |
| <span class="source-line-no">298</span><span id="line-298"> case "schema": return toType(getSchema(), type);</span> |
| <span class="source-line-no">299</span><span id="line-299"> default: return super.get(property, type);</span> |
| <span class="source-line-no">300</span><span id="line-300"> }</span> |
| <span class="source-line-no">301</span><span id="line-301"> }</span> |
| <span class="source-line-no">302</span><span id="line-302"></span> |
| <span class="source-line-no">303</span><span id="line-303"> @Override /* SwaggerElement */</span> |
| <span class="source-line-no">304</span><span id="line-304"> public ResponseInfo set(String property, Object value) {</span> |
| <span class="source-line-no">305</span><span id="line-305"> if (property == null)</span> |
| <span class="source-line-no">306</span><span id="line-306"> return this;</span> |
| <span class="source-line-no">307</span><span id="line-307"> switch (property) {</span> |
| <span class="source-line-no">308</span><span id="line-308"> case "description": return setDescription(stringify(value));</span> |
| <span class="source-line-no">309</span><span id="line-309"> case "examples": return setExamples(mapBuilder(String.class,Object.class).sparse().addAny(value).build());</span> |
| <span class="source-line-no">310</span><span id="line-310"> case "headers": return setHeaders(mapBuilder(String.class,HeaderInfo.class).sparse().addAny(value).build());</span> |
| <span class="source-line-no">311</span><span id="line-311"> case "schema": return setSchema(toType(value, SchemaInfo.class));</span> |
| <span class="source-line-no">312</span><span id="line-312"> default:</span> |
| <span class="source-line-no">313</span><span id="line-313"> super.set(property, value);</span> |
| <span class="source-line-no">314</span><span id="line-314"> return this;</span> |
| <span class="source-line-no">315</span><span id="line-315"> }</span> |
| <span class="source-line-no">316</span><span id="line-316"> }</span> |
| <span class="source-line-no">317</span><span id="line-317"></span> |
| <span class="source-line-no">318</span><span id="line-318"> @Override /* SwaggerElement */</span> |
| <span class="source-line-no">319</span><span id="line-319"> public Set<String> keySet() {</span> |
| <span class="source-line-no">320</span><span id="line-320"> Set<String> s = setBuilder(String.class)</span> |
| <span class="source-line-no">321</span><span id="line-321"> .addIf(description != null, "description")</span> |
| <span class="source-line-no">322</span><span id="line-322"> .addIf(examples != null, "examples")</span> |
| <span class="source-line-no">323</span><span id="line-323"> .addIf(headers != null, "headers")</span> |
| <span class="source-line-no">324</span><span id="line-324"> .addIf(schema != null, "schema")</span> |
| <span class="source-line-no">325</span><span id="line-325"> .build();</span> |
| <span class="source-line-no">326</span><span id="line-326"> return new MultiSet<>(s, super.keySet());</span> |
| <span class="source-line-no">327</span><span id="line-327"> }</span> |
| <span class="source-line-no">328</span><span id="line-328"></span> |
| <span class="source-line-no">329</span><span id="line-329"> /**</span> |
| <span class="source-line-no">330</span><span id="line-330"> * Resolves any <js>"$ref"</js> attributes in this element.</span> |
| <span class="source-line-no">331</span><span id="line-331"> *</span> |
| <span class="source-line-no">332</span><span id="line-332"> * @param swagger The swagger document containing the definitions.</span> |
| <span class="source-line-no">333</span><span id="line-333"> * @param refStack Keeps track of previously-visited references so that we don't cause recursive loops.</span> |
| <span class="source-line-no">334</span><span id="line-334"> * @param maxDepth</span> |
| <span class="source-line-no">335</span><span id="line-335"> * The maximum depth to resolve references.</span> |
| <span class="source-line-no">336</span><span id="line-336"> * <br>After that level is reached, <c>$ref</c> references will be left alone.</span> |
| <span class="source-line-no">337</span><span id="line-337"> * <br>Useful if you have very complex models and you don't want your swagger page to be overly-complex.</span> |
| <span class="source-line-no">338</span><span id="line-338"> * @return</span> |
| <span class="source-line-no">339</span><span id="line-339"> * This object with references resolved.</span> |
| <span class="source-line-no">340</span><span id="line-340"> * <br>May or may not be the same object.</span> |
| <span class="source-line-no">341</span><span id="line-341"> */</span> |
| <span class="source-line-no">342</span><span id="line-342"> public ResponseInfo resolveRefs(Swagger swagger, Deque<String> refStack, int maxDepth) {</span> |
| <span class="source-line-no">343</span><span id="line-343"></span> |
| <span class="source-line-no">344</span><span id="line-344"> if (schema != null)</span> |
| <span class="source-line-no">345</span><span id="line-345"> schema = schema.resolveRefs(swagger, refStack, maxDepth);</span> |
| <span class="source-line-no">346</span><span id="line-346"></span> |
| <span class="source-line-no">347</span><span id="line-347"> if (headers != null)</span> |
| <span class="source-line-no">348</span><span id="line-348"> headers.entrySet().forEach(x -> x.setValue(x.getValue().resolveRefs(swagger, refStack, maxDepth)));</span> |
| <span class="source-line-no">349</span><span id="line-349"></span> |
| <span class="source-line-no">350</span><span id="line-350"> return this;</span> |
| <span class="source-line-no">351</span><span id="line-351"> }</span> |
| <span class="source-line-no">352</span><span id="line-352">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
