http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/Swagger.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/Swagger.html b/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/Swagger.html index 6f19807..400b5a2 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/Swagger.html +++ b/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/Swagger.html @@ -24,878 +24,877 @@ <span class="sourceLineNo">016</span><a name="line.16"></a> <span class="sourceLineNo">017</span>import org.apache.juneau.*;<a name="line.17"></a> <span class="sourceLineNo">018</span>import org.apache.juneau.annotation.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * This is the root document object for the API specification.<a name="line.21"></a> -<span class="sourceLineNo">022</span> * <p><a name="line.22"></a> -<span class="sourceLineNo">023</span> * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a> for usage information.<a name="line.23"></a> -<span class="sourceLineNo">024</span> */<a name="line.24"></a> -<span class="sourceLineNo">025</span>@Bean(properties="swagger,info,tags,externalDocs,basePath,schemes,consumes,produces,paths,definitions,parameters,responses,securityDefinitions,security")<a name="line.25"></a> -<span class="sourceLineNo">026</span>@SuppressWarnings("hiding")<a name="line.26"></a> -<span class="sourceLineNo">027</span>public class Swagger extends SwaggerElement {<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span> /** Represents a null swagger */<a name="line.29"></a> -<span class="sourceLineNo">030</span> public static final Swagger NULL = new Swagger();<a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span> private String swagger = "2.0";<a name="line.32"></a> -<span class="sourceLineNo">033</span> private Info info;<a name="line.33"></a> -<span class="sourceLineNo">034</span> private String host, basePath;<a name="line.34"></a> -<span class="sourceLineNo">035</span> private List<String> schemes;<a name="line.35"></a> -<span class="sourceLineNo">036</span> private List<MediaType> consumes;<a name="line.36"></a> -<span class="sourceLineNo">037</span> private List<MediaType> produces;<a name="line.37"></a> -<span class="sourceLineNo">038</span> private Map<String,Map<String,Operation>> paths;<a name="line.38"></a> -<span class="sourceLineNo">039</span> private Map<String,SchemaInfo> definitions;<a name="line.39"></a> -<span class="sourceLineNo">040</span> private Map<String,ParameterInfo> parameters;<a name="line.40"></a> -<span class="sourceLineNo">041</span> private Map<String,ResponseInfo> responses;<a name="line.41"></a> -<span class="sourceLineNo">042</span> private Map<String,SecurityScheme> securityDefinitions;<a name="line.42"></a> -<span class="sourceLineNo">043</span> private List<Map<String,List<String>>> security;<a name="line.43"></a> -<span class="sourceLineNo">044</span> private List<Tag> tags;<a name="line.44"></a> -<span class="sourceLineNo">045</span> private ExternalDocumentation externalDocs;<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span> /**<a name="line.47"></a> -<span class="sourceLineNo">048</span> * Bean property getter: <property>swagger</property>.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> -<span class="sourceLineNo">050</span> * Required. Specifies the Swagger Specification version being used.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * It can be used by the Swagger UI and other clients to interpret the API listing.<a name="line.51"></a> -<span class="sourceLineNo">052</span> * The value MUST be <js>"2.0"</js>.<a name="line.52"></a> -<span class="sourceLineNo">053</span> *<a name="line.53"></a> -<span class="sourceLineNo">054</span> * @return The value of the <property>swagger</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span> public String getSwagger() {<a name="line.56"></a> -<span class="sourceLineNo">057</span> return swagger;<a name="line.57"></a> -<span class="sourceLineNo">058</span> }<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> /**<a name="line.60"></a> -<span class="sourceLineNo">061</span> * Bean property setter: <property>swagger</property>.<a name="line.61"></a> -<span class="sourceLineNo">062</span> * <p><a name="line.62"></a> -<span class="sourceLineNo">063</span> * Required. Specifies the Swagger Specification version being used.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * It can be used by the Swagger UI and other clients to interpret the API listing.<a name="line.64"></a> -<span class="sourceLineNo">065</span> * The value MUST be <js>"2.0"</js>.<a name="line.65"></a> -<span class="sourceLineNo">066</span> *<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @param swagger The new value for the <property>swagger</property> property on this bean.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @return This object (for method chaining).<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> public Swagger setSwagger(String swagger) {<a name="line.70"></a> -<span class="sourceLineNo">071</span> this.swagger = swagger;<a name="line.71"></a> -<span class="sourceLineNo">072</span> return this;<a name="line.72"></a> -<span class="sourceLineNo">073</span> }<a name="line.73"></a> -<span class="sourceLineNo">074</span><a name="line.74"></a> -<span class="sourceLineNo">075</span> /**<a name="line.75"></a> -<span class="sourceLineNo">076</span> * Synonym for {@link #setSwagger(String)}.<a name="line.76"></a> -<span class="sourceLineNo">077</span> *<a name="line.77"></a> -<span class="sourceLineNo">078</span> * @param swagger The new value for the <property>swagger</property> property on this bean.<a name="line.78"></a> -<span class="sourceLineNo">079</span> * @return This object (for method chaining).<a name="line.79"></a> -<span class="sourceLineNo">080</span> */<a name="line.80"></a> -<span class="sourceLineNo">081</span> public Swagger swagger(String swagger) {<a name="line.81"></a> -<span class="sourceLineNo">082</span> return setSwagger(swagger);<a name="line.82"></a> -<span class="sourceLineNo">083</span> }<a name="line.83"></a> -<span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span> /**<a name="line.85"></a> -<span class="sourceLineNo">086</span> * Bean property getter: <property>info</property>.<a name="line.86"></a> -<span class="sourceLineNo">087</span> * <p><a name="line.87"></a> -<span class="sourceLineNo">088</span> * Required. Provides metadata about the API.<a name="line.88"></a> -<span class="sourceLineNo">089</span> * The metadata can be used by the clients if needed.<a name="line.89"></a> -<span class="sourceLineNo">090</span> *<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @return The value of the <property>info</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.91"></a> -<span class="sourceLineNo">092</span> */<a name="line.92"></a> -<span class="sourceLineNo">093</span> public Info getInfo() {<a name="line.93"></a> -<span class="sourceLineNo">094</span> return info;<a name="line.94"></a> -<span class="sourceLineNo">095</span> }<a name="line.95"></a> -<span class="sourceLineNo">096</span><a name="line.96"></a> -<span class="sourceLineNo">097</span> /**<a name="line.97"></a> -<span class="sourceLineNo">098</span> * Bean property setter: <property>info</property>.<a name="line.98"></a> -<span class="sourceLineNo">099</span> * <p><a name="line.99"></a> -<span class="sourceLineNo">100</span> * Required. Provides metadata about the API.<a name="line.100"></a> -<span class="sourceLineNo">101</span> * The metadata can be used by the clients if needed.<a name="line.101"></a> -<span class="sourceLineNo">102</span> *<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @param info The new value for the <property>info</property> property on this bean.<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @return This object (for method chaining).<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> public Swagger setInfo(Info info) {<a name="line.106"></a> -<span class="sourceLineNo">107</span> this.info = info;<a name="line.107"></a> -<span class="sourceLineNo">108</span> return this;<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<a name="line.109"></a> -<span class="sourceLineNo">110</span><a name="line.110"></a> -<span class="sourceLineNo">111</span> /**<a name="line.111"></a> -<span class="sourceLineNo">112</span> * Synonym for {@link #setInfo(Info)}.<a name="line.112"></a> -<span class="sourceLineNo">113</span> *<a name="line.113"></a> -<span class="sourceLineNo">114</span> * @param info The new value for the <property>info</property> property on this bean.<a name="line.114"></a> -<span class="sourceLineNo">115</span> * @return This object (for method chaining).<a name="line.115"></a> -<span class="sourceLineNo">116</span> */<a name="line.116"></a> -<span class="sourceLineNo">117</span> public Swagger info(Info info) {<a name="line.117"></a> -<span class="sourceLineNo">118</span> return setInfo(info);<a name="line.118"></a> -<span class="sourceLineNo">119</span> }<a name="line.119"></a> -<span class="sourceLineNo">120</span><a name="line.120"></a> -<span class="sourceLineNo">121</span> /**<a name="line.121"></a> -<span class="sourceLineNo">122</span> * Bean property getter: <property>host</property>.<a name="line.122"></a> -<span class="sourceLineNo">123</span> * <p><a name="line.123"></a> -<span class="sourceLineNo">124</span> * The host (name or ip) serving the API.<a name="line.124"></a> -<span class="sourceLineNo">125</span> * This MUST be the host only and does not include the scheme nor sub-paths.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * It MAY include a port.<a name="line.126"></a> -<span class="sourceLineNo">127</span> * If the host is not included, the host serving the documentation is to be used (including the port).<a name="line.127"></a> -<span class="sourceLineNo">128</span> * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.<a name="line.128"></a> -<span class="sourceLineNo">129</span> *<a name="line.129"></a> -<span class="sourceLineNo">130</span> * @return The value of the <property>host</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.130"></a> -<span class="sourceLineNo">131</span> */<a name="line.131"></a> -<span class="sourceLineNo">132</span> public String getHost() {<a name="line.132"></a> -<span class="sourceLineNo">133</span> return host;<a name="line.133"></a> -<span class="sourceLineNo">134</span> }<a name="line.134"></a> -<span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> /**<a name="line.136"></a> -<span class="sourceLineNo">137</span> * Bean property setter: <property>host</property>.<a name="line.137"></a> -<span class="sourceLineNo">138</span> * <p><a name="line.138"></a> -<span class="sourceLineNo">139</span> * The host (name or ip) serving the API.<a name="line.139"></a> -<span class="sourceLineNo">140</span> * This MUST be the host only and does not include the scheme nor sub-paths.<a name="line.140"></a> -<span class="sourceLineNo">141</span> * It MAY include a port.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * If the host is not included, the host serving the documentation is to be used (including the port).<a name="line.142"></a> -<span class="sourceLineNo">143</span> * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.<a name="line.143"></a> -<span class="sourceLineNo">144</span> *<a name="line.144"></a> -<span class="sourceLineNo">145</span> * @param host The new value for the <property>host</property> property on this bean.<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @return This object (for method chaining).<a name="line.146"></a> -<span class="sourceLineNo">147</span> */<a name="line.147"></a> -<span class="sourceLineNo">148</span> public Swagger setHost(String host) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> this.host = host;<a name="line.149"></a> -<span class="sourceLineNo">150</span> return this;<a name="line.150"></a> -<span class="sourceLineNo">151</span> }<a name="line.151"></a> -<span class="sourceLineNo">152</span><a name="line.152"></a> -<span class="sourceLineNo">153</span> /**<a name="line.153"></a> -<span class="sourceLineNo">154</span> * Synonym for {@link #setHost(String)}.<a name="line.154"></a> -<span class="sourceLineNo">155</span> *<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @param host The new value for the <property>host</property> property on this bean.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @return This object (for method chaining).<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> public Swagger host(String host) {<a name="line.159"></a> -<span class="sourceLineNo">160</span> return setHost(host);<a name="line.160"></a> -<span class="sourceLineNo">161</span> }<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> /**<a name="line.163"></a> -<span class="sourceLineNo">164</span> * Bean property getter: <property>basePath</property>.<a name="line.164"></a> -<span class="sourceLineNo">165</span> * <p><a name="line.165"></a> -<span class="sourceLineNo">166</span> * The base path on which the API is served, which is relative to the <code>host</code>.<a name="line.166"></a> -<span class="sourceLineNo">167</span> * If it is not included, the API is served directly under the <code>host</code>.<a name="line.167"></a> -<span class="sourceLineNo">168</span> * The value MUST start with a leading slash (/).<a name="line.168"></a> -<span class="sourceLineNo">169</span> * The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.<a name="line.169"></a> -<span class="sourceLineNo">170</span> *<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @return The value of the <property>basePath</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.171"></a> -<span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> public String getBasePath() {<a name="line.173"></a> -<span class="sourceLineNo">174</span> return basePath;<a name="line.174"></a> -<span class="sourceLineNo">175</span> }<a name="line.175"></a> -<span class="sourceLineNo">176</span><a name="line.176"></a> -<span class="sourceLineNo">177</span> /**<a name="line.177"></a> -<span class="sourceLineNo">178</span> * Bean property setter: <property>basePath</property>.<a name="line.178"></a> -<span class="sourceLineNo">179</span> * <p><a name="line.179"></a> -<span class="sourceLineNo">180</span> * The base path on which the API is served, which is relative to the <code>host</code>.<a name="line.180"></a> -<span class="sourceLineNo">181</span> * If it is not included, the API is served directly under the <code>host</code>.<a name="line.181"></a> -<span class="sourceLineNo">182</span> * The value MUST start with a leading slash (/).<a name="line.182"></a> -<span class="sourceLineNo">183</span> * The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.<a name="line.183"></a> -<span class="sourceLineNo">184</span> *<a name="line.184"></a> -<span class="sourceLineNo">185</span> * @param basePath The new value for the <property>basePath</property> property on this bean.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @return This object (for method chaining).<a name="line.186"></a> -<span class="sourceLineNo">187</span> */<a name="line.187"></a> -<span class="sourceLineNo">188</span> public Swagger setBasePath(String basePath) {<a name="line.188"></a> -<span class="sourceLineNo">189</span> this.basePath = basePath;<a name="line.189"></a> -<span class="sourceLineNo">190</span> return this;<a name="line.190"></a> -<span class="sourceLineNo">191</span> }<a name="line.191"></a> -<span class="sourceLineNo">192</span><a name="line.192"></a> -<span class="sourceLineNo">193</span> /**<a name="line.193"></a> -<span class="sourceLineNo">194</span> * Synonym for {@link #setBasePath(String)}.<a name="line.194"></a> -<span class="sourceLineNo">195</span> *<a name="line.195"></a> -<span class="sourceLineNo">196</span> * @param basePath The new value for the <property>basePath</property> property on this bean.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @return This object (for method chaining).<a name="line.197"></a> -<span class="sourceLineNo">198</span> */<a name="line.198"></a> -<span class="sourceLineNo">199</span> public Swagger basePath(String basePath) {<a name="line.199"></a> -<span class="sourceLineNo">200</span> return setBasePath(basePath);<a name="line.200"></a> -<span class="sourceLineNo">201</span> }<a name="line.201"></a> -<span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> /**<a name="line.203"></a> -<span class="sourceLineNo">204</span> * Bean property getter: <property>schemes</property>.<a name="line.204"></a> -<span class="sourceLineNo">205</span> * <p><a name="line.205"></a> -<span class="sourceLineNo">206</span> * The transfer protocol of the API.<a name="line.206"></a> -<span class="sourceLineNo">207</span> * Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.<a name="line.207"></a> -<span class="sourceLineNo">208</span> * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.<a name="line.208"></a> -<span class="sourceLineNo">209</span> *<a name="line.209"></a> -<span class="sourceLineNo">210</span> * @return The value of the <property>schemes</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.210"></a> -<span class="sourceLineNo">211</span> */<a name="line.211"></a> -<span class="sourceLineNo">212</span> public List<String> getSchemes() {<a name="line.212"></a> -<span class="sourceLineNo">213</span> return schemes;<a name="line.213"></a> -<span class="sourceLineNo">214</span> }<a name="line.214"></a> -<span class="sourceLineNo">215</span><a name="line.215"></a> -<span class="sourceLineNo">216</span> /**<a name="line.216"></a> -<span class="sourceLineNo">217</span> * Bean property setter: <property>schemes</property>.<a name="line.217"></a> -<span class="sourceLineNo">218</span> * <p><a name="line.218"></a> -<span class="sourceLineNo">219</span> * The transfer protocol of the API.<a name="line.219"></a> -<span class="sourceLineNo">220</span> * Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.<a name="line.220"></a> -<span class="sourceLineNo">221</span> * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.<a name="line.221"></a> -<span class="sourceLineNo">222</span> *<a name="line.222"></a> -<span class="sourceLineNo">223</span> * @param schemes The new value for the <property>schemes</property> property on this bean.<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @return This object (for method chaining).<a name="line.224"></a> -<span class="sourceLineNo">225</span> */<a name="line.225"></a> -<span class="sourceLineNo">226</span> public Swagger setSchemes(List<String> schemes) {<a name="line.226"></a> -<span class="sourceLineNo">227</span> this.schemes = schemes;<a name="line.227"></a> -<span class="sourceLineNo">228</span> return this;<a name="line.228"></a> -<span class="sourceLineNo">229</span> }<a name="line.229"></a> -<span class="sourceLineNo">230</span><a name="line.230"></a> -<span class="sourceLineNo">231</span> /**<a name="line.231"></a> -<span class="sourceLineNo">232</span> * Bean property adder: <property>schemes</property>.<a name="line.232"></a> -<span class="sourceLineNo">233</span> * <p><a name="line.233"></a> -<span class="sourceLineNo">234</span> * The transfer protocol of the API.<a name="line.234"></a> -<span class="sourceLineNo">235</span> * Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.<a name="line.235"></a> -<span class="sourceLineNo">236</span> * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.<a name="line.236"></a> -<span class="sourceLineNo">237</span> *<a name="line.237"></a> -<span class="sourceLineNo">238</span> * @param schemes The values to add for the <property>schemes</property> property on this bean.<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @return This object (for method chaining).<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> public Swagger addSchemes(String...schemes) {<a name="line.241"></a> -<span class="sourceLineNo">242</span> return addSchemes(Arrays.asList(schemes));<a name="line.242"></a> -<span class="sourceLineNo">243</span> }<a name="line.243"></a> -<span class="sourceLineNo">244</span><a name="line.244"></a> -<span class="sourceLineNo">245</span> /**<a name="line.245"></a> -<span class="sourceLineNo">246</span> * Bean property adder: <property>schemes</property>.<a name="line.246"></a> -<span class="sourceLineNo">247</span> * <p><a name="line.247"></a> -<span class="sourceLineNo">248</span> * The transfer protocol of the API.<a name="line.248"></a> -<span class="sourceLineNo">249</span> * Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.<a name="line.249"></a> -<span class="sourceLineNo">250</span> * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.<a name="line.250"></a> -<span class="sourceLineNo">251</span> *<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param schemes The values to add for the <property>schemes</property> property on this bean.<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @return This object (for method chaining).<a name="line.253"></a> -<span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> public Swagger addSchemes(Collection<String> schemes) {<a name="line.255"></a> -<span class="sourceLineNo">256</span> if (schemes != null) {<a name="line.256"></a> -<span class="sourceLineNo">257</span> if (this.schemes == null)<a name="line.257"></a> -<span class="sourceLineNo">258</span> this.schemes = new LinkedList<String>();<a name="line.258"></a> -<span class="sourceLineNo">259</span> this.schemes.addAll(schemes);<a name="line.259"></a> -<span class="sourceLineNo">260</span> }<a name="line.260"></a> -<span class="sourceLineNo">261</span> return this;<a name="line.261"></a> -<span class="sourceLineNo">262</span> }<a name="line.262"></a> -<span class="sourceLineNo">263</span><a name="line.263"></a> -<span class="sourceLineNo">264</span> /**<a name="line.264"></a> -<span class="sourceLineNo">265</span> * Synonym for {@link #addSchemes(String...)}.<a name="line.265"></a> -<span class="sourceLineNo">266</span> *<a name="line.266"></a> -<span class="sourceLineNo">267</span> * @param schemes The values to add for the <property>schemes</property> property on this bean.<a name="line.267"></a> -<span class="sourceLineNo">268</span> * @return This object (for method chaining).<a name="line.268"></a> -<span class="sourceLineNo">269</span> */<a name="line.269"></a> -<span class="sourceLineNo">270</span> public Swagger schemes(String...schemes) {<a name="line.270"></a> -<span class="sourceLineNo">271</span> return addSchemes(schemes);<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> /**<a name="line.274"></a> -<span class="sourceLineNo">275</span> * Bean property getter: <property>consumes</property>.<a name="line.275"></a> -<span class="sourceLineNo">276</span> * <p><a name="line.276"></a> -<span class="sourceLineNo">277</span> * A list of MIME types the APIs can consume.<a name="line.277"></a> -<span class="sourceLineNo">278</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.278"></a> -<span class="sourceLineNo">279</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.279"></a> -<span class="sourceLineNo">280</span> *<a name="line.280"></a> -<span class="sourceLineNo">281</span> * @return The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.281"></a> -<span class="sourceLineNo">282</span> */<a name="line.282"></a> -<span class="sourceLineNo">283</span> public List<MediaType> getConsumes() {<a name="line.283"></a> -<span class="sourceLineNo">284</span> return consumes;<a name="line.284"></a> -<span class="sourceLineNo">285</span> }<a name="line.285"></a> -<span class="sourceLineNo">286</span><a name="line.286"></a> -<span class="sourceLineNo">287</span> /**<a name="line.287"></a> -<span class="sourceLineNo">288</span> * Bean property setter: <property>consumes</property>.<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <p><a name="line.289"></a> -<span class="sourceLineNo">290</span> * A list of MIME types the APIs can consume.<a name="line.290"></a> -<span class="sourceLineNo">291</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.291"></a> -<span class="sourceLineNo">292</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.292"></a> -<span class="sourceLineNo">293</span> *<a name="line.293"></a> -<span class="sourceLineNo">294</span> * @param consumes The new value for the <property>consumes</property> property on this bean.<a name="line.294"></a> -<span class="sourceLineNo">295</span> * @return This object (for method chaining).<a name="line.295"></a> -<span class="sourceLineNo">296</span> */<a name="line.296"></a> -<span class="sourceLineNo">297</span> public Swagger setConsumes(List<MediaType> consumes) {<a name="line.297"></a> -<span class="sourceLineNo">298</span> this.consumes = consumes;<a name="line.298"></a> -<span class="sourceLineNo">299</span> return this;<a name="line.299"></a> -<span class="sourceLineNo">300</span> }<a name="line.300"></a> -<span class="sourceLineNo">301</span><a name="line.301"></a> -<span class="sourceLineNo">302</span> /**<a name="line.302"></a> -<span class="sourceLineNo">303</span> * Bean property adder: <property>consumes</property>.<a name="line.303"></a> -<span class="sourceLineNo">304</span> * <p><a name="line.304"></a> -<span class="sourceLineNo">305</span> * A list of MIME types the APIs can consume.<a name="line.305"></a> -<span class="sourceLineNo">306</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.306"></a> -<span class="sourceLineNo">307</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.307"></a> -<span class="sourceLineNo">308</span> *<a name="line.308"></a> -<span class="sourceLineNo">309</span> * @param consumes The values to add for the <property>consumes</property> property on this bean.<a name="line.309"></a> -<span class="sourceLineNo">310</span> * @return This object (for method chaining).<a name="line.310"></a> -<span class="sourceLineNo">311</span> */<a name="line.311"></a> -<span class="sourceLineNo">312</span> public Swagger addConsumes(MediaType...consumes) {<a name="line.312"></a> -<span class="sourceLineNo">313</span> return addConsumes(Arrays.asList(consumes));<a name="line.313"></a> -<span class="sourceLineNo">314</span> }<a name="line.314"></a> -<span class="sourceLineNo">315</span><a name="line.315"></a> -<span class="sourceLineNo">316</span> /**<a name="line.316"></a> -<span class="sourceLineNo">317</span> * Bean property adder: <property>consumes</property>.<a name="line.317"></a> -<span class="sourceLineNo">318</span> * <p><a name="line.318"></a> -<span class="sourceLineNo">319</span> * A list of MIME types the APIs can consume.<a name="line.319"></a> -<span class="sourceLineNo">320</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.320"></a> -<span class="sourceLineNo">321</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.321"></a> -<span class="sourceLineNo">322</span> *<a name="line.322"></a> -<span class="sourceLineNo">323</span> * @param consumes The values to add for the <property>consumes</property> property on this bean.<a name="line.323"></a> -<span class="sourceLineNo">324</span> * @return This object (for method chaining).<a name="line.324"></a> -<span class="sourceLineNo">325</span> */<a name="line.325"></a> -<span class="sourceLineNo">326</span> public Swagger addConsumes(Collection<MediaType> consumes) {<a name="line.326"></a> -<span class="sourceLineNo">327</span> if (consumes != null) {<a name="line.327"></a> -<span class="sourceLineNo">328</span> if (this.consumes == null)<a name="line.328"></a> -<span class="sourceLineNo">329</span> this.consumes = new LinkedList<MediaType>();<a name="line.329"></a> -<span class="sourceLineNo">330</span> this.consumes.addAll(consumes);<a name="line.330"></a> -<span class="sourceLineNo">331</span> }<a name="line.331"></a> -<span class="sourceLineNo">332</span> return this;<a name="line.332"></a> -<span class="sourceLineNo">333</span> }<a name="line.333"></a> -<span class="sourceLineNo">334</span><a name="line.334"></a> -<span class="sourceLineNo">335</span> /**<a name="line.335"></a> -<span class="sourceLineNo">336</span> * Synonym for {@link #addConsumes(MediaType...)}.<a name="line.336"></a> -<span class="sourceLineNo">337</span> *<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @param consumes The values to add for the <property>consumes</property> property on this bean.<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @return This object (for method chaining).<a name="line.339"></a> -<span class="sourceLineNo">340</span> */<a name="line.340"></a> -<span class="sourceLineNo">341</span> public Swagger consumes(MediaType...consumes) {<a name="line.341"></a> -<span class="sourceLineNo">342</span> return addConsumes(consumes);<a name="line.342"></a> -<span class="sourceLineNo">343</span> }<a name="line.343"></a> -<span class="sourceLineNo">344</span><a name="line.344"></a> -<span class="sourceLineNo">345</span> /**<a name="line.345"></a> -<span class="sourceLineNo">346</span> * Synonym for {@link #addConsumes(Collection)}.<a name="line.346"></a> -<span class="sourceLineNo">347</span> *<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @param consumes The values to add for the <property>consumes</property> property on this bean.<a name="line.348"></a> -<span class="sourceLineNo">349</span> * @return This object (for method chaining).<a name="line.349"></a> -<span class="sourceLineNo">350</span> */<a name="line.350"></a> -<span class="sourceLineNo">351</span> public Swagger consumes(Collection<MediaType> consumes) {<a name="line.351"></a> -<span class="sourceLineNo">352</span> return addConsumes(consumes);<a name="line.352"></a> -<span class="sourceLineNo">353</span> }<a name="line.353"></a> -<span class="sourceLineNo">354</span><a name="line.354"></a> -<span class="sourceLineNo">355</span> /**<a name="line.355"></a> -<span class="sourceLineNo">356</span> * Bean property getter: <property>produces</property>.<a name="line.356"></a> -<span class="sourceLineNo">357</span> * <p><a name="line.357"></a> -<span class="sourceLineNo">358</span> * A list of MIME types the APIs can produce.<a name="line.358"></a> -<span class="sourceLineNo">359</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.359"></a> -<span class="sourceLineNo">360</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.360"></a> -<span class="sourceLineNo">361</span> *<a name="line.361"></a> -<span class="sourceLineNo">362</span> * @return The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.362"></a> -<span class="sourceLineNo">363</span> */<a name="line.363"></a> -<span class="sourceLineNo">364</span> public List<MediaType> getProduces() {<a name="line.364"></a> -<span class="sourceLineNo">365</span> return produces;<a name="line.365"></a> -<span class="sourceLineNo">366</span> }<a name="line.366"></a> -<span class="sourceLineNo">367</span><a name="line.367"></a> -<span class="sourceLineNo">368</span> /**<a name="line.368"></a> -<span class="sourceLineNo">369</span> * Bean property setter: <property>produces</property>.<a name="line.369"></a> -<span class="sourceLineNo">370</span> * <p><a name="line.370"></a> -<span class="sourceLineNo">371</span> * A list of MIME types the APIs can produce.<a name="line.371"></a> -<span class="sourceLineNo">372</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.372"></a> -<span class="sourceLineNo">373</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.373"></a> -<span class="sourceLineNo">374</span> *<a name="line.374"></a> -<span class="sourceLineNo">375</span> * @param produces The new value for the <property>produces</property> property on this bean.<a name="line.375"></a> -<span class="sourceLineNo">376</span> * @return This object (for method chaining).<a name="line.376"></a> -<span class="sourceLineNo">377</span> */<a name="line.377"></a> -<span class="sourceLineNo">378</span> public Swagger setProduces(List<MediaType> produces) {<a name="line.378"></a> -<span class="sourceLineNo">379</span> this.produces = produces;<a name="line.379"></a> -<span class="sourceLineNo">380</span> return this;<a name="line.380"></a> -<span class="sourceLineNo">381</span> }<a name="line.381"></a> -<span class="sourceLineNo">382</span><a name="line.382"></a> -<span class="sourceLineNo">383</span> /**<a name="line.383"></a> -<span class="sourceLineNo">384</span> * Bean property adder: <property>produces</property>.<a name="line.384"></a> -<span class="sourceLineNo">385</span> * <p><a name="line.385"></a> -<span class="sourceLineNo">386</span> * A list of MIME types the APIs can produce.<a name="line.386"></a> -<span class="sourceLineNo">387</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.387"></a> -<span class="sourceLineNo">388</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.388"></a> -<span class="sourceLineNo">389</span> *<a name="line.389"></a> -<span class="sourceLineNo">390</span> * @param produces The values to add for the <property>produces</property> property on this bean.<a name="line.390"></a> -<span class="sourceLineNo">391</span> * @return This object (for method chaining).<a name="line.391"></a> -<span class="sourceLineNo">392</span> */<a name="line.392"></a> -<span class="sourceLineNo">393</span> public Swagger addProduces(MediaType...produces) {<a name="line.393"></a> -<span class="sourceLineNo">394</span> return addProduces(Arrays.asList(produces));<a name="line.394"></a> -<span class="sourceLineNo">395</span> }<a name="line.395"></a> -<span class="sourceLineNo">396</span><a name="line.396"></a> -<span class="sourceLineNo">397</span> /**<a name="line.397"></a> -<span class="sourceLineNo">398</span> * Bean property adder: <property>produces</property>.<a name="line.398"></a> -<span class="sourceLineNo">399</span> * <p><a name="line.399"></a> -<span class="sourceLineNo">400</span> * A list of MIME types the APIs can produce.<a name="line.400"></a> -<span class="sourceLineNo">401</span> * This is global to all APIs but can be overridden on specific API calls.<a name="line.401"></a> -<span class="sourceLineNo">402</span> * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.<a name="line.402"></a> -<span class="sourceLineNo">403</span> *<a name="line.403"></a> -<span class="sourceLineNo">404</span> * @param produces The values to add for the <property>produces</property> property on this bean.<a name="line.404"></a> -<span class="sourceLineNo">405</span> * @return This object (for method chaining).<a name="line.405"></a> -<span class="sourceLineNo">406</span> */<a name="line.406"></a> -<span class="sourceLineNo">407</span> public Swagger addProduces(Collection<MediaType> produces) {<a name="line.407"></a> -<span class="sourceLineNo">408</span> if (produces != null) {<a name="line.408"></a> -<span class="sourceLineNo">409</span> if (this.produces == null)<a name="line.409"></a> -<span class="sourceLineNo">410</span> this.produces = new LinkedList<MediaType>();<a name="line.410"></a> -<span class="sourceLineNo">411</span> this.produces.addAll(produces);<a name="line.411"></a> -<span class="sourceLineNo">412</span> }<a name="line.412"></a> -<span class="sourceLineNo">413</span> return this;<a name="line.413"></a> -<span class="sourceLineNo">414</span> }<a name="line.414"></a> -<span class="sourceLineNo">415</span><a name="line.415"></a> -<span class="sourceLineNo">416</span> /**<a name="line.416"></a> -<span class="sourceLineNo">417</span> * Synonym for {@link #addProduces(MediaType...)}.<a name="line.417"></a> -<span class="sourceLineNo">418</span> *<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @param produces The values to add for the <property>produces</property> property on this bean.<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @return This object (for method chaining).<a name="line.420"></a> -<span class="sourceLineNo">421</span> */<a name="line.421"></a> -<span class="sourceLineNo">422</span> public Swagger produces(MediaType...produces) {<a name="line.422"></a> -<span class="sourceLineNo">423</span> return addProduces(produces);<a name="line.423"></a> -<span class="sourceLineNo">424</span> }<a name="line.424"></a> -<span class="sourceLineNo">425</span><a name="line.425"></a> -<span class="sourceLineNo">426</span> /**<a name="line.426"></a> -<span class="sourceLineNo">427</span> * Synonym for {@link #addProduces(Collection)}.<a name="line.427"></a> -<span class="sourceLineNo">428</span> *<a name="line.428"></a> -<span class="sourceLineNo">429</span> * @param produces The values to add for the <property>produces</property> property on this bean.<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @return This object (for method chaining).<a name="line.430"></a> -<span class="sourceLineNo">431</span> */<a name="line.431"></a> -<span class="sourceLineNo">432</span> public Swagger produces(Collection<MediaType> produces) {<a name="line.432"></a> -<span class="sourceLineNo">433</span> return addProduces(produces);<a name="line.433"></a> -<span class="sourceLineNo">434</span> }<a name="line.434"></a> -<span class="sourceLineNo">435</span><a name="line.435"></a> -<span class="sourceLineNo">436</span> /**<a name="line.436"></a> -<span class="sourceLineNo">437</span> * Bean property getter: <property>paths</property>.<a name="line.437"></a> -<span class="sourceLineNo">438</span> * <p><a name="line.438"></a> -<span class="sourceLineNo">439</span> * Required. The available paths and operations for the API.<a name="line.439"></a> -<span class="sourceLineNo">440</span> *<a name="line.440"></a> -<span class="sourceLineNo">441</span> * @return The value of the <property>paths</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.441"></a> -<span class="sourceLineNo">442</span> */<a name="line.442"></a> -<span class="sourceLineNo">443</span> public Map<String,Map<String,Operation>> getPaths() {<a name="line.443"></a> -<span class="sourceLineNo">444</span> return paths;<a name="line.444"></a> -<span class="sourceLineNo">445</span> }<a name="line.445"></a> -<span class="sourceLineNo">446</span><a name="line.446"></a> -<span class="sourceLineNo">447</span> /**<a name="line.447"></a> -<span class="sourceLineNo">448</span> * Bean property setter: <property>paths</property>.<a name="line.448"></a> -<span class="sourceLineNo">449</span> * <p><a name="line.449"></a> -<span class="sourceLineNo">450</span> * Required. The available paths and operations for the API.<a name="line.450"></a> -<span class="sourceLineNo">451</span> *<a name="line.451"></a> -<span class="sourceLineNo">452</span> * @param paths The new value for the <property>paths</property> property on this bean.<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @return This object (for method chaining).<a name="line.453"></a> -<span class="sourceLineNo">454</span> */<a name="line.454"></a> -<span class="sourceLineNo">455</span> public Swagger setPaths(Map<String,Map<String,Operation>> paths) {<a name="line.455"></a> -<span class="sourceLineNo">456</span> this.paths = paths;<a name="line.456"></a> -<span class="sourceLineNo">457</span> return this;<a name="line.457"></a> -<span class="sourceLineNo">458</span> }<a name="line.458"></a> -<span class="sourceLineNo">459</span><a name="line.459"></a> -<span class="sourceLineNo">460</span> /**<a name="line.460"></a> -<span class="sourceLineNo">461</span> * Bean property adder: <property>paths</property>.<a name="line.461"></a> -<span class="sourceLineNo">462</span> * <p><a name="line.462"></a> -<span class="sourceLineNo">463</span> * Required. The available paths and operations for the API.<a name="line.463"></a> -<span class="sourceLineNo">464</span> *<a name="line.464"></a> -<span class="sourceLineNo">465</span> * @param path The path template.<a name="line.465"></a> -<span class="sourceLineNo">466</span> * @param methodName The HTTP method name.<a name="line.466"></a> -<span class="sourceLineNo">467</span> * @param operation The operation that describes the path.<a name="line.467"></a> -<span class="sourceLineNo">468</span> * @return This object (for method chaining).<a name="line.468"></a> -<span class="sourceLineNo">469</span> */<a name="line.469"></a> -<span class="sourceLineNo">470</span> public Swagger addPath(String path, String methodName, Operation operation) {<a name="line.470"></a> -<span class="sourceLineNo">471</span> if (paths == null)<a name="line.471"></a> -<span class="sourceLineNo">472</span> paths = new TreeMap<String,Map<String,Operation>>();<a name="line.472"></a> -<span class="sourceLineNo">473</span> Map<String,Operation> p = paths.get(path);<a name="line.473"></a> -<span class="sourceLineNo">474</span> if (p == null) {<a name="line.474"></a> -<span class="sourceLineNo">475</span> p = new TreeMap<String,Operation>(new MethodSorter());<a name="line.475"></a> -<span class="sourceLineNo">476</span> paths.put(path, p);<a name="line.476"></a> -<span class="sourceLineNo">477</span> }<a name="line.477"></a> -<span class="sourceLineNo">478</span> p.put(methodName, operation);<a name="line.478"></a> -<span class="sourceLineNo">479</span> return this;<a name="line.479"></a> -<span class="sourceLineNo">480</span> }<a name="line.480"></a> -<span class="sourceLineNo">481</span><a name="line.481"></a> -<span class="sourceLineNo">482</span> /**<a name="line.482"></a> -<span class="sourceLineNo">483</span> * Synonym for {@link #path(String,String,Operation)}.<a name="line.483"></a> -<span class="sourceLineNo">484</span> *<a name="line.484"></a> -<span class="sourceLineNo">485</span> * @param path The path template.<a name="line.485"></a> -<span class="sourceLineNo">486</span> * @param methodName The HTTP method name.<a name="line.486"></a> -<span class="sourceLineNo">487</span> * @param operation The operation that describes the path.<a name="line.487"></a> -<span class="sourceLineNo">488</span> * @return This object (for method chaining).<a name="line.488"></a> -<span class="sourceLineNo">489</span> */<a name="line.489"></a> -<span class="sourceLineNo">490</span> public Swagger path(String path, String methodName, Operation operation) {<a name="line.490"></a> -<span class="sourceLineNo">491</span> return addPath(path, methodName, operation);<a name="line.491"></a> -<span class="sourceLineNo">492</span> }<a name="line.492"></a> -<span class="sourceLineNo">493</span><a name="line.493"></a> -<span class="sourceLineNo">494</span> /**<a name="line.494"></a> -<span class="sourceLineNo">495</span> * Bean property getter: <property>definitions</property>.<a name="line.495"></a> -<span class="sourceLineNo">496</span> * <p><a name="line.496"></a> -<span class="sourceLineNo">497</span> * An object to hold data types produced and consumed by operations.<a name="line.497"></a> -<span class="sourceLineNo">498</span> *<a name="line.498"></a> -<span class="sourceLineNo">499</span> * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.499"></a> -<span class="sourceLineNo">500</span> */<a name="line.500"></a> -<span class="sourceLineNo">501</span> public Map<String,SchemaInfo> getDefinitions() {<a name="line.501"></a> -<span class="sourceLineNo">502</span> return definitions;<a name="line.502"></a> -<span class="sourceLineNo">503</span> }<a name="line.503"></a> -<span class="sourceLineNo">504</span><a name="line.504"></a> -<span class="sourceLineNo">505</span> /**<a name="line.505"></a> -<span class="sourceLineNo">506</span> * Bean property setter: <property>definitions</property>.<a name="line.506"></a> -<span class="sourceLineNo">507</span> * <p><a name="line.507"></a> -<span class="sourceLineNo">508</span> * An object to hold data types produced and consumed by operations.<a name="line.508"></a> -<span class="sourceLineNo">509</span> *<a name="line.509"></a> -<span class="sourceLineNo">510</span> * @param definitions The new value for the <property>definitions</property> property on this bean.<a name="line.510"></a> -<span class="sourceLineNo">511</span> * @return This object (for method chaining).<a name="line.511"></a> -<span class="sourceLineNo">512</span> */<a name="line.512"></a> -<span class="sourceLineNo">513</span> public Swagger setDefinitions(Map<String,SchemaInfo> definitions) {<a name="line.513"></a> -<span class="sourceLineNo">514</span> this.definitions = definitions;<a name="line.514"></a> -<span class="sourceLineNo">515</span> return this;<a name="line.515"></a> -<span class="sourceLineNo">516</span> }<a name="line.516"></a> -<span class="sourceLineNo">517</span><a name="line.517"></a> -<span class="sourceLineNo">518</span> /**<a name="line.518"></a> -<span class="sourceLineNo">519</span> * Bean property adder: <property>definitions</property>.<a name="line.519"></a> -<span class="sourceLineNo">520</span> * <p><a name="line.520"></a> -<span class="sourceLineNo">521</span> * An object to hold data types produced and consumed by operations.<a name="line.521"></a> -<span class="sourceLineNo">522</span> *<a name="line.522"></a> -<span class="sourceLineNo">523</span> * @param name A definition name.<a name="line.523"></a> -<span class="sourceLineNo">524</span> * @param schema The schema that the name defines.<a name="line.524"></a> -<span class="sourceLineNo">525</span> * @return This object (for method chaining).<a name="line.525"></a> -<span class="sourceLineNo">526</span> */<a name="line.526"></a> -<span class="sourceLineNo">527</span> public Swagger addDefinition(String name, SchemaInfo schema) {<a name="line.527"></a> -<span class="sourceLineNo">528</span> if (definitions == null)<a name="line.528"></a> -<span class="sourceLineNo">529</span> definitions = new TreeMap<String,SchemaInfo>();<a name="line.529"></a> -<span class="sourceLineNo">530</span> definitions.put(name, schema);<a name="line.530"></a> -<span class="sourceLineNo">531</span> return this;<a name="line.531"></a> -<span class="sourceLineNo">532</span> }<a name="line.532"></a> -<span class="sourceLineNo">533</span><a name="line.533"></a> -<span class="sourceLineNo">534</span> /**<a name="line.534"></a> -<span class="sourceLineNo">535</span> * Synonym for {@link #addDefinition(String,SchemaInfo)}.<a name="line.535"></a> -<span class="sourceLineNo">536</span> *<a name="line.536"></a> -<span class="sourceLineNo">537</span> * @param name A definition name.<a name="line.537"></a> -<span class="sourceLineNo">538</span> * @param schema The schema that the name defines.<a name="line.538"></a> -<span class="sourceLineNo">539</span> * @return This object (for method chaining).<a name="line.539"></a> -<span class="sourceLineNo">540</span> */<a name="line.540"></a> -<span class="sourceLineNo">541</span> public Swagger xxx(String name, SchemaInfo schema) {<a name="line.541"></a> -<span class="sourceLineNo">542</span> return addDefinition(name, schema);<a name="line.542"></a> -<span class="sourceLineNo">543</span> }<a name="line.543"></a> -<span class="sourceLineNo">544</span><a name="line.544"></a> -<span class="sourceLineNo">545</span> /**<a name="line.545"></a> -<span class="sourceLineNo">546</span> * Bean property getter: <property>parameters</property>.<a name="line.546"></a> -<span class="sourceLineNo">547</span> * <p><a name="line.547"></a> -<span class="sourceLineNo">548</span> * An object to hold parameters that can be used across operations.<a name="line.548"></a> -<span class="sourceLineNo">549</span> * This property does not define global parameters for all operations.<a name="line.549"></a> -<span class="sourceLineNo">550</span> *<a name="line.550"></a> -<span class="sourceLineNo">551</span> * @return The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.551"></a> -<span class="sourceLineNo">552</span> */<a name="line.552"></a> -<span class="sourceLineNo">553</span> public Map<String,ParameterInfo> getParameters() {<a name="line.553"></a> -<span class="sourceLineNo">554</span> return parameters;<a name="line.554"></a> -<span class="sourceLineNo">555</span> }<a name="line.555"></a> -<span class="sourceLineNo">556</span><a name="line.556"></a> -<span class="sourceLineNo">557</span> /**<a name="line.557"></a> -<span class="sourceLineNo">558</span> * Bean property setter: <property>parameters</property>.<a name="line.558"></a> -<span class="sourceLineNo">559</span> * <p><a name="line.559"></a> -<span class="sourceLineNo">560</span> * An object to hold parameters that can be used across operations.<a name="line.560"></a> -<span class="sourceLineNo">561</span> * This property does not define global parameters for all operations.<a name="line.561"></a> -<span class="sourceLineNo">562</span> *<a name="line.562"></a> -<span class="sourceLineNo">563</span> * @param parameters The new value for the <property>parameters</property> property on this bean.<a name="line.563"></a> -<span class="sourceLineNo">564</span> * @return This object (for method chaining).<a name="line.564"></a> -<span class="sourceLineNo">565</span> */<a name="line.565"></a> -<span class="sourceLineNo">566</span> public Swagger setParameters(Map<String,ParameterInfo> parameters) {<a name="line.566"></a> -<span class="sourceLineNo">567</span> this.parameters = parameters;<a name="line.567"></a> -<span class="sourceLineNo">568</span> return this;<a name="line.568"></a> -<span class="sourceLineNo">569</span> }<a name="line.569"></a> -<span class="sourceLineNo">570</span><a name="line.570"></a> -<span class="sourceLineNo">571</span> /**<a name="line.571"></a> -<span class="sourceLineNo">572</span> * Bean property adder: <property>parameters</property>.<a name="line.572"></a> -<span class="sourceLineNo">573</span> * <p><a name="line.573"></a> -<span class="sourceLineNo">574</span> * An object to hold parameters that can be used across operations.<a name="line.574"></a> -<span class="sourceLineNo">575</span> * This property does not define global parameters for all operations.<a name="line.575"></a> -<span class="sourceLineNo">576</span> *<a name="line.576"></a> -<span class="sourceLineNo">577</span> * @param name The parameter name.<a name="line.577"></a> -<span class="sourceLineNo">578</span> * @param parameter The parameter definition.<a name="line.578"></a> -<span class="sourceLineNo">579</span> * @return This object (for method chaining).<a name="line.579"></a> -<span class="sourceLineNo">580</span> */<a name="line.580"></a> -<span class="sourceLineNo">581</span> public Swagger addParameter(String name, ParameterInfo parameter) {<a name="line.581"></a> -<span class="sourceLineNo">582</span> if (parameters == null)<a name="line.582"></a> -<span class="sourceLineNo">583</span> parameters = new TreeMap<String,ParameterInfo>();<a name="line.583"></a> -<span class="sourceLineNo">584</span> parameters.put(name, parameter);<a name="line.584"></a> -<span class="sourceLineNo">585</span> return this;<a name="line.585"></a> -<span class="sourceLineNo">586</span> }<a name="line.586"></a> -<span class="sourceLineNo">587</span><a name="line.587"></a> -<span class="sourceLineNo">588</span> /**<a name="line.588"></a> -<span class="sourceLineNo">589</span> * Synonym for {@link #addParameter(String,ParameterInfo)}.<a name="line.589"></a> -<span class="sourceLineNo">590</span> *<a name="line.590"></a> -<span class="sourceLineNo">591</span> * @param name The parameter name.<a name="line.591"></a> -<span class="sourceLineNo">592</span> * @param parameter The parameter definition.<a name="line.592"></a> -<span class="sourceLineNo">593</span> * @return This object (for method chaining).<a name="line.593"></a> -<span class="sourceLineNo">594</span> */<a name="line.594"></a> -<span class="sourceLineNo">595</span> public Swagger parameter(String name, ParameterInfo parameter) {<a name="line.595"></a> -<span class="sourceLineNo">596</span> return addParameter(name, parameter);<a name="line.596"></a> -<span class="sourceLineNo">597</span> }<a name="line.597"></a> -<span class="sourceLineNo">598</span><a name="line.598"></a> -<span class="sourceLineNo">599</span> /**<a name="line.599"></a> -<span class="sourceLineNo">600</span> * Bean property getter: <property>responses</property>.<a name="line.600"></a> -<span class="sourceLineNo">601</span> * <p><a name="line.601"></a> -<span class="sourceLineNo">602</span> * An object to hold responses that can be used across operations.<a name="line.602"></a> -<span class="sourceLineNo">603</span> * This property does not define global responses for all operations.<a name="line.603"></a> -<span class="sourceLineNo">604</span> *<a name="line.604"></a> -<span class="sourceLineNo">605</span> * @return The value of the <property>responses</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.605"></a> -<span class="sourceLineNo">606</span> */<a name="line.606"></a> -<span class="sourceLineNo">607</span> public Map<String,ResponseInfo> getResponses() {<a name="line.607"></a> -<span class="sourceLineNo">608</span> return responses;<a name="line.608"></a> -<span class="sourceLineNo">609</span> }<a name="line.609"></a> -<span class="sourceLineNo">610</span><a name="line.610"></a> -<span class="sourceLineNo">611</span> /**<a name="line.611"></a> -<span class="sourceLineNo">612</span> * Bean property setter: <property>responses</property>.<a name="line.612"></a> -<span class="sourceLineNo">613</span> * <p><a name="line.613"></a> -<span class="sourceLineNo">614</span> * An object to hold responses that can be used across operations.<a name="line.614"></a> -<span class="sourceLineNo">615</span> * This property does not define global responses for all operations.<a name="line.615"></a> -<span class="sourceLineNo">616</span> *<a name="line.616"></a> -<span class="sourceLineNo">617</span> * @param responses The new value for the <property>responses</property> property on this bean.<a name="line.617"></a> -<span class="sourceLineNo">618</span> * @return This object (for method chaining).<a name="line.618"></a> -<span class="sourceLineNo">619</span> */<a name="line.619"></a> -<span class="sourceLineNo">620</span> public Swagger setResponses(Map<String,ResponseInfo> responses) {<a name="line.620"></a> -<span class="sourceLineNo">621</span> this.responses = responses;<a name="line.621"></a> -<span class="sourceLineNo">622</span> return this;<a name="line.622"></a> -<span class="sourceLineNo">623</span> }<a name="line.623"></a> -<span class="sourceLineNo">624</span><a name="line.624"></a> -<span class="sourceLineNo">625</span> /**<a name="line.625"></a> -<span class="sourceLineNo">626</span> * Bean property adder: <property>responses</property>.<a name="line.626"></a> -<span class="sourceLineNo">627</span> * <p><a name="line.627"></a> -<span class="sourceLineNo">628</span> * An object to hold responses that can be used across operations.<a name="line.628"></a> -<span class="sourceLineNo">629</span> * This property does not define global responses for all operations.<a name="line.629"></a> -<span class="sourceLineNo">630</span> *<a name="line.630"></a> -<span class="sourceLineNo">631</span> * @param name The response name.<a name="line.631"></a> -<span class="sourceLineNo">632</span> * @param response The response definition.<a name="line.632"></a> -<span class="sourceLineNo">633</span> * @return This object (for method chaining).<a name="line.633"></a> -<span class="sourceLineNo">634</span> */<a name="line.634"></a> -<span class="sourceLineNo">635</span> public Swagger addResponse(String name, ResponseInfo response) {<a name="line.635"></a> -<span class="sourceLineNo">636</span> if (responses == null)<a name="line.636"></a> -<span class="sourceLineNo">637</span> responses = new TreeMap<String,ResponseInfo>();<a name="line.637"></a> -<span class="sourceLineNo">638</span> responses.put(name, response);<a name="line.638"></a> -<span class="sourceLineNo">639</span> return this;<a name="line.639"></a> -<span class="sourceLineNo">640</span> }<a name="line.640"></a> -<span class="sourceLineNo">641</span><a name="line.641"></a> -<span class="sourceLineNo">642</span> /**<a name="line.642"></a> -<span class="sourceLineNo">643</span> * Synonym for {@link #addResponse(String,ResponseInfo)}.<a name="line.643"></a> -<span class="sourceLineNo">644</span> *<a name="line.644"></a> -<span class="sourceLineNo">645</span> * @param name The response name.<a name="line.645"></a> -<span class="sourceLineNo">646</span> * @param response The response definition.<a name="line.646"></a> -<span class="sourceLineNo">647</span> * @return This object (for method chaining).<a name="line.647"></a> -<span class="sourceLineNo">648</span> */<a name="line.648"></a> -<span class="sourceLineNo">649</span> public Swagger response(String name, ResponseInfo response) {<a name="line.649"></a> -<span class="sourceLineNo">650</span> return addResponse(name, response);<a name="line.650"></a> -<span class="sourceLineNo">651</span> }<a name="line.651"></a> -<span class="sourceLineNo">652</span><a name="line.652"></a> -<span class="sourceLineNo">653</span> /**<a name="line.653"></a> -<span class="sourceLineNo">654</span> * Bean property getter: <property>securityDefinitions</property>.<a name="line.654"></a> -<span class="sourceLineNo">655</span> * <p><a name="line.655"></a> -<span class="sourceLineNo">656</span> * Security scheme definitions that can be used across the specification.<a name="line.656"></a> -<span class="sourceLineNo">657</span> *<a name="line.657"></a> -<span class="sourceLineNo">658</span> * @return The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.658"></a> -<span class="sourceLineNo">659</span> */<a name="line.659"></a> -<span class="sourceLineNo">660</span> public Map<String,SecurityScheme> getSecurityDefinitions() {<a name="line.660"></a> -<span class="sourceLineNo">661</span> return securityDefinitions;<a name="line.661"></a> -<span class="sourceLineNo">662</span> }<a name="line.662"></a> -<span class="sourceLineNo">663</span><a name="line.663"></a> -<span class="sourceLineNo">664</span> /**<a name="line.664"></a> -<span class="sourceLineNo">665</span> * Bean property setter: <property>securityDefinitions</property>.<a name="line.665"></a> -<span class="sourceLineNo">666</span> * <p><a name="line.666"></a> -<span class="sourceLineNo">667</span> * Security scheme definitions that can be used across the specification.<a name="line.667"></a> -<span class="sourceLineNo">668</span> *<a name="line.668"></a> -<span class="sourceLineNo">669</span> * @param securityDefinitions The new value for the <property>securityDefinitions</property> property on this bean.<a name="line.669"></a> -<span class="sourceLineNo">670</span> * @return This object (for method chaining).<a name="line.670"></a> -<span class="sourceLineNo">671</span> */<a name="line.671"></a> -<span class="sourceLineNo">672</span> public Swagger setSecurityDefinitions(Map<String,SecurityScheme> securityDefinitions) {<a name="line.672"></a> -<span class="sourceLineNo">673</span> this.securityDefinitions = securityDefinitions;<a name="line.673"></a> -<span class="sourceLineNo">674</span> return this;<a name="line.674"></a> -<span class="sourceLineNo">675</span> }<a name="line.675"></a> -<span class="sourceLineNo">676</span><a name="line.676"></a> -<span class="sourceLineNo">677</span> /**<a name="line.677"></a> -<span class="sourceLineNo">678</span> * Bean property adder: <property>securityDefinitions</property>.<a name="line.678"></a> -<span class="sourceLineNo">679</span> * <p><a name="line.679"></a> -<span class="sourceLineNo">680</span> * Security scheme definitions that can be used across the specification.<a name="line.680"></a> -<span class="sourceLineNo">681</span> *<a name="line.681"></a> -<span class="sourceLineNo">682</span> * @param name A security name.<a name="line.682"></a> -<span class="sourceLineNo">683</span> * @param securityScheme A security schema.<a name="line.683"></a> -<span class="sourceLineNo">684</span> * @return This object (for method chaining).<a name="line.684"></a> -<span class="sourceLineNo">685</span> */<a name="line.685"></a> -<span class="sourceLineNo">686</span> public Swagger addSecurityDefinition(String name, SecurityScheme securityScheme) {<a name="line.686"></a> -<span class="sourceLineNo">687</span> if (securityDefinitions == null)<a name="line.687"></a> -<span class="sourceLineNo">688</span> securityDefinitions = new TreeMap<String,SecurityScheme>();<a name="line.688"></a> -<span class="sourceLineNo">689</span> securityDefinitions.put(name, securityScheme);<a name="line.689"></a> -<span class="sourceLineNo">690</span> return this;<a name="line.690"></a> -<span class="sourceLineNo">691</span> }<a name="line.691"></a> -<span class="sourceLineNo">692</span><a name="line.692"></a> -<span class="sourceLineNo">693</span> /**<a name="line.693"></a> -<span class="sourceLineNo">694</span> * Synonym for {@link #addSecurityDefinition(String,SecurityScheme)}.<a name="line.694"></a> -<span class="sourceLineNo">695</span> *<a name="line.695"></a> -<span class="sourceLineNo">696</span> * @param name A security name.<a name="line.696"></a> -<span class="sourceLineNo">697</span> * @param securityScheme A security schema.<a name="line.697"></a> -<span class="sourceLineNo">698</span> * @return This object (for method chaining).<a name="line.698"></a> -<span class="sourceLineNo">699</span> */<a name="line.699"></a> -<span class="sourceLineNo">700</span> public Swagger securityDefinition(String name, SecurityScheme securityScheme) {<a name="line.700"></a> -<span class="sourceLineNo">701</span> return addSecurityDefinition(name, securityScheme);<a name="line.701"></a> -<span class="sourceLineNo">702</span> }<a name="line.702"></a> -<span class="sourceLineNo">703</span><a name="line.703"></a> -<span class="sourceLineNo">704</span> /**<a name="line.704"></a> -<span class="sourceLineNo">705</span> * Bean property getter: <property>security</property>.<a name="line.705"></a> -<span class="sourceLineNo">706</span> * <p><a name="line.706"></a> -<span class="sourceLineNo">707</span> * A declaration of which security schemes are applied for the API as a whole.<a name="line.707"></a> -<span class="sourceLineNo">708</span> * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).<a name="line.708"></a> -<span class="sourceLineNo">709</span> * Individual operations can override this definition.<a name="line.709"></a> -<span class="sourceLineNo">710</span> *<a name="line.710"></a> -<span class="sourceLineNo">711</span> * @return The value of the <property>security</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.711"></a> -<span class="sourceLineNo">712</span> */<a name="line.712"></a> -<span class="sourceLineNo">713</span> public List<Map<String,List<String>>> getSecurity() {<a name="line.713"></a> -<span class="sourceLineNo">714</span> return security;<a name="line.714"></a> -<span class="sourceLineNo">715</span> }<a name="line.715"></a> -<span class="sourceLineNo">716</span><a name="line.716"></a> -<span class="sourceLineNo">717</span> /**<a name="line.717"></a> -<span class="sourceLineNo">718</span> * Bean property setter: <property>security</property>.<a name="line.718"></a> -<span class="sourceLineNo">719</span> * <p><a name="line.719"></a> -<span class="sourceLineNo">720</span> * A declaration of which security schemes are applied for the API as a whole.<a name="line.720"></a> -<span class="sourceLineNo">721</span> * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).<a name="line.721"></a> -<span class="sourceLineNo">722</span> * Individual operations can override this definition.<a name="line.722"></a> -<span class="sourceLineNo">723</span> *<a name="line.723"></a> -<span class="sourceLineNo">724</span> * @param security The new value for the <property>security</property> property on this bean.<a name="line.724"></a> -<span class="sourceLineNo">725</span> * @return This object (for method chaining).<a name="line.725"></a> -<span class="sourceLineNo">726</span> */<a name="line.726"></a> -<span class="sourceLineNo">727</span> public Swagger setSecurity(List<Map<String,List<String>>> security) {<a name="line.727"></a> -<span class="sourceLineNo">728</span> this.security = security;<a name="line.728"></a> -<span class="sourceLineNo">729</span> return this;<a name="line.729"></a> -<span class="sourceLineNo">730</span> }<a name="line.730"></a> -<span class="sourceLineNo">731</span><a name="line.731"></a> -<span class="sourceLineNo">732</span> /**<a name="line.732"></a> -<span class="sourceLineNo">733</span> * Bean property adder: <property>security</property>.<a name="line.733"></a> -<span class="sourceLineNo">734</span> * <p><a name="line.734"></a> -<span class="sourceLineNo">735</span> * A declaration of which security schemes are applied for the API as a whole.<a name="line.735"></a> -<span class="sourceLineNo">736</span> * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).<a name="line.736"></a> -<span class="sourceLineNo">737</span> * Individual operations can override this definition.<a name="line.737"></a> -<span class="sourceLineNo">738</span> *<a name="line.738"></a> -<span class="sourceLineNo">739</span> * @param security The value to add for the <property>security</property> property on this bean.<a name="line.739"></a> -<span class="sourceLineNo">740</span> * @return This object (for method chaining).<a name="line.740"></a> -<span class="sourceLineNo">741</span> */<a name="line.741"></a> -<span class="sourceLineNo">742</span> public Swagger addSecurity(Map<String,List<String>> security) {<a name="line.742"></a> -<span class="sourceLineNo">743</span> if (this.security == null)<a name="line.743"></a> -<span class="sourceLineNo">744</span> this.security = new LinkedList<Map<String,List<String>>>();<a name="line.744"></a> -<span class="sourceLineNo">745</span> this.security.add(security);<a name="line.745"></a> -<span class="sourceLineNo">746</span> return this;<a name="line.746"></a> -<span class="sourceLineNo">747</span> }<a name="line.747"></a> -<span class="sourceLineNo">748</span><a name="line.748"></a> -<span class="sourceLineNo">749</span> /**<a name="line.749"></a> -<span class="sourceLineNo">750</span> * Synonym for {@link #addSecurity(Map)}.<a name="line.750"></a> -<span class="sourceLineNo">751</span> *<a name="line.751"></a> -<span class="sourceLineNo">752</span> * @param scheme The security scheme that applies to this operation<a name="line.752"></a> -<span class="sourceLineNo">753</span> * @param alternatives The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).<a name="line.753"></a> -<span class="sourceLineNo">754</span> * @return This object (for method chaining).<a name="line.754"></a> -<span class="sourceLineNo">755</span> */<a name="line.755"></a> -<span class="sourceLineNo">756</span> public Swagger security(String scheme, String...alternatives) {<a name="line.756"></a> -<span class="sourceLineNo">757</span> Map<String,List<String>> m = new LinkedHashMap<String,List<String>>();<a name="line.757"></a> -<span class="sourceLineNo">758</span> m.put(scheme, Arrays.asList(alternatives));<a name="line.758"></a> -<span class="sourceLineNo">759</span> return addSecurity(m);<a name="line.759"></a> -<span class="sourceLineNo">760</span> }<a name="line.760"></a> -<span class="sourceLineNo">761</span><a name="line.761"></a> -<span class="sourceLineNo">762</span> /**<a name="line.762"></a> -<span class="sourceLineNo">763</span> * Bean property getter: <property>tags</property>.<a name="line.763"></a> -<span class="sourceLineNo">764</span> * <p><a name="line.764"></a> -<span class="sourceLineNo">765</span> * A list of tags used by the specification with additional metadata.<a name="line.765"></a> -<span class="sourceLineNo">766</span> * The order of the tags can be used to reflect on their order by the parsing tools.<a name="line.766"></a> -<span class="sourceLineNo">767</span> * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.<a name="line.767"></a> -<span class="sourceLineNo">768</span> * The tags that are not declared may be organized randomly or based on the tools' logic.<a name="line.768"></a> -<span class="sourceLineNo">769</span> * Each tag name in the list MUST be unique.<a name="line.769"></a> -<span class="sourceLineNo">770</span> *<a name="line.770"></a> -<span class="sourceLineNo">771</span> * @return The value of the <property>tags</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.771"></a> -<span class="sourceLineNo">772</span> */<a name="line.772"></a> -<span class="sourceLineNo">773</span> public List<Tag> getTags() {<a name="line.773"></a> -<span class="sourceLineNo">774</span> return tags;<a name="line.774"></a> -<span class="sourceLineNo">775</span> }<a name="line.775"></a> -<span class="sourceLineNo">776</span><a name="line.776"></a> -<span class="sourceLineNo">777</span> /**<a name="line.777"></a> -<span class="sourceLineNo">778</span> * Bean property setter: <property>tags</property>.<a name="line.778"></a> -<span class="sourceLineNo">779</span> * <p><a name="line.779"></a> -<span class="sourceLineNo">780</span> * A list of tags used by the specification with additional metadata.<a name="line.780"></a> -<span class="sourceLineNo">781</span> * The order of the tags can be used to reflect on their order by the parsing tools.<a name="line.781"></a> -<span class="sourceLineNo">782</span> * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.<a name="line.782"></a> -<span class="sourceLineNo">783</span> * The tags that are not declared may be organized randomly or based on the tools' logic.<a name="line.783"></a> -<span class="sourceLineNo">784</span> * Each tag name in the list MUST be unique.<a name="line.784"></a> -<span class="sourceLineNo">785</span> *<a name="line.785"></a> -<span class="sourceLineNo">786</span> * @param tags The new value for the <property>tags</property> property on this bean.<a name="line.786"></a> -<span class="sourceLineNo">787</span> * @return This object (for method chaining).<a name="line.787"></a> -<span class="sourceLineNo">788</span> */<a name="line.788"></a> -<span class="sourceLineNo">789</span> public Swagger setTags(List<Tag> tags) {<a name="line.789"></a> -<span class="sourceLineNo">790</span> this.tags = tags;<a name="line.790"></a> -<span class="sourceLineNo">791</span> return this;<a name="line.791"></a> -<span class="sourceLineNo">792</span> }<a name="line.792"></a> -<span class="sourceLineNo">793</span><a name="line.793"></a> -<span class="sourceLineNo">794</span> /**<a name="line.794"></a> -<span class="sourceLineNo">795</span> * Bean property adder: <property>tags</property>.<a name="line.795"></a> -<span class="sourceLineNo">796</span> * <p><a name="line.796"></a> -<span class="sourceLineNo">797</span> * A list of tags used by the specification with additional metadata.<a name="line.797"></a> -<span class="sourceLineNo">798</span> * The order of the tags can be used to reflect on their order by the parsing tools.<a name="line.798"></a> -<span class="sourceLineNo">799</span> * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.<a name="line.799"></a> -<span class="sourceLineNo">800</span> * The tags that are not declared may be organized randomly or based on the tools' logic.<a name="line.800"></a> -<span class="sourceLineNo">801</span> * Each tag name in the list MUST be unique.<a name="line.801"></a> -<span class="sourceLineNo">802</span> *<a name="line.802"></a> -<span class="sourceLineNo">803</span> * @param tags The values to add for the <property>tags</property> property on this bean.<a name="line.803"></a> -<span class="sourceLineNo">804</span> * @return This object (for method chaining).<a name="line.804"></a> -<span class="sourceLineNo">805</span> */<a name="line.805"></a> -<span class="sourceLineNo">806</span> public Swagger addTags(Tag...tags) {<a name="line.806"></a> -<span class="sourceLineNo">807</span> if (this.tags == null)<a name="line.807"></a> -<span class="sourceLineNo">808</span> this.tags = new LinkedList<Tag>();<a name="line.808"></a> -<span class="sourceLineNo">809</span> this.tags.addAll(Arrays.asList(tags));<a name="line.809"></a> -<span class="sourceLineNo">810</span> return this;<a name="line.810"></a> -<span class="sourceLineNo">811</span> }<a name="line.811"></a> -<span class="sourceLineNo">812</span><a name="line.812"></a> -<span class="sourceLineNo">813</span> /**<a name="line.813"></a> -<span class="sourceLineNo">814</span> * Synonym for {@link #addTags(Tag...)}.<a name="line.814"></a> -<span class="sourceLineNo">815</span> *<a name="line.815"></a> -<span class="sourceLineNo">816</span> * @param tags The values to add for the <property>tags</property> property on this bean.<a name="line.816"></a> -<span class="sourceLineNo">817</span> * @return This object (for method chaining).<a name="line.817"></a> -<span class="sourceLineNo">818</span> */<a name="line.818"></a> -<span class="sourceLineNo">819</span> public Swagger tags(Tag...tags) {<a name="line.819"></a> -<span class="sourceLineNo">820</span> return addTags(tags);<a name="line.820"></a> -<span class="sourceLineNo">821</span> }<a name="line.821"></a> -<span class="sourceLineNo">822</span><a name="line.822"></a> -<span class="sourceLineNo">823</span> /**<a name="line.823"></a> -<span class="sourceLineNo">824</span> * Synonym for {@link #setTags(List)}.<a name="line.824"></a> -<span class="sourceLineNo">825</span> *<a name="line.825"></a> -<span class="sourceLineNo">826</span> * @param tags The values to add for the <property>tags</property> property on this bean.<a name="line.826"></a> -<span class="sourceLineNo">827</span> * @return This object (for method chaining).<a name="line.827"></a> -<span class="sourceLineNo">828</span> */<a name="line.828"></a> -<span class="sourceLineNo">829</span> public Swagger tags(List<Tag> tags) {<a name="line.829"></a> -<span class="sourceLineNo">830</span> return setTags(tags);<a name="line.830"></a> -<span class="sourceLineNo">831</span> }<a name="line.831"></a> -<span class="sourceLineNo">832</span><a name="line.832"></a> -<span class="sourceLineNo">833</span> /**<a name="line.833"></a> -<span class="sourceLineNo">834</span> * Bean property getter: <property>externalDocs</property>.<a name="line.834"></a> -<span class="sourceLineNo">835</span> * <p><a name="line.835"></a> -<span class="sourceLineNo">836</span> * Additional external documentation.<a name="line.836"></a> -<span class="sourceLineNo">837</span> *<a name="line.837"></a> -<span class="sourceLineNo">838</span> * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.838"></a> -<span class="sourceLineNo">839</span> */<a name="line.839"></a> -<span class="sourceLineNo">840</span> public ExternalDocumentation getExternalDocs() {<a name="line.840"></a> -<span class="sourceLineNo">841</span> return externalDocs;<a name="line.841"></a> -<span class="sourceLineNo">842</span> }<a name="line.842"></a> -<span class="sourceLineNo">843</span><a name="line.843"></a> -<span class="sourceLineNo">844</span> /**<a name="line.844"></a> -<span class="sourceLineNo">845</span> * Bean property setter: <property>externalDocs</property>.<a name="line.845"></a> -<span class="sourceLineNo">846</span> * <p><a name="line.846"></a> -<span class="sourceLineNo">847</span> * Additional external documentation.<a name="line.847"></a> -<span class="sourceLineNo">848</span> *<a name="line.848"></a> -<span class="sourceLineNo">849</span> * @param externalDocs The new value for the <property>externalDocs</property> property on this bean.<a name="line.849"></a> -<span class="sourceLineNo">850</span> * @return This object (for method chaining).<a name="line.850"></a> -<span class="sourceLineNo">851</span> */<a name="line.851"></a> -<span class="sourceLineNo">852</span> public Swagger setExternalDocs(ExternalDocumentation externalDocs) {<a name="line.852"></a> -<span class="sourceLineNo">853</span> this.externalDocs = externalDocs;<a name="line.853"></a> -<span class="sourceLineNo">854</span> return this;<a name="line.854"></a> -<span class="sourceLineNo">855</span> }<a name="line.855"></a> -<span class="sourceLineNo">856</span><a name="line.856"></a> -<span class="sourceLineNo">857</span> /**<a name="line.857"></a> -<span class="sourceLineNo">858</span> * Synonym for {@link #setExternalDocs(ExternalDocumentation)}.<a name="line.858"></a> -<span class="sourceLineNo">859</span> *<a name="line.859"></a> -<span class="sourceLineNo">860</span> * @param externalDocs The new value for the <property>externalDocs</property> property on this bean.<a name="line.860"></a> -<span class="sourceLineNo">861</span> * @return This object (for method chaining).<a name="line.861"></a> -<span class="sourceLineNo">862</span> */<a name="line.862"></a> -<span class="sourceLineNo">863</span> public Swagger externalDocs(ExternalDocumentation externalDocs) {<a name="line.863"></a> -<span class="sourceLineNo">864</span> return setExternalDocs(externalDocs);<a name="line.864"></a> -<span class="sourceLineNo">865</span> }<a name="line.865"></a> -<span class="sourceLineNo">866</span><a name="line.866"></a> -<span class="sourceLineNo">867</span> private static class MethodSorter implements Comparator<String> {<a name="line.867"></a> -<span class="sourceLineNo">868</span> @SuppressWarnings("serial")<a name="line.868"></a> -<span class="sourceLineNo">869</span> private final Map<String,Integer> methods = new HashMap<String,Integer>(){{<a name="line.869"></a> -<span class="sourceLineNo">870</span> put("get",7);<a name="line.870"></a> -<span class="sourceLineNo">871</span> put("put",6);<a name="line.871"></a> -<span class="sourceLineNo">872</span> put("post",5);<a name="line.872"></a> -<span class="sourceLineNo">873</span> put("delete",4);<a name="line.873"></a> -<span class="sourceLineNo">874</span> put("options",3);<a name="line.874"></a> -<span class="sourceLineNo">875</span> put("head",2);<a name="line.875"></a> -<span class="sourceLineNo">876</span> put("patch",1);<a name="line.876"></a> -<span class="sourceLineNo">877</span> }};<a name="line.877"></a> -<span class="sourceLineNo">878</span><a name="line.878"></a> -<span class="sourceLineNo">879</span> @Override<a name="line.879"></a> -<span class="sourceLineNo">880</span> public int compare(String o1, String o2) {<a name="line.880"></a> -<span class="sourceLineNo">881</span> Integer i1 = methods.get(o1);<a name="line.881"></a> -<span class="sourceLineNo">882</span> Integer i2 = methods.get(o2);<a name="line.882"></a> -<span class="sourceLineNo">883</span> if (i1 == null)<a name="line.883"></a> -<span class="sourceLineNo">884</span> i1 = 0;<a name="line.884"></a> -<span class="sourceLineNo">885</span> if (i2 == null)<a name="line.885"></a> -<span class="sourceLineNo">886</span> i2 = 0;<a name="line.886"></a> -<span class="sourceLineNo">887</span> return i2.compareTo(i1);<a name="line.887"></a> -<span class="sourceLineNo">888</span> }<a name="line.888"></a> -<span class="sourceLineNo">889</span> }<a name="line.889"></a> -<span class="sourceLineNo">890</span>}<a name="line.890"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.utils.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * This is the root document object for the API specification.<a name="line.22"></a> +<span class="sourceLineNo">023</span> * <p><a name="line.23"></a> +<span class="sourceLineNo">024</span> * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a> for usage information.<a name="line.24"></a> +<span class="sourceLineNo">025</span> */<a name="line.25"></a> +<span class="sourceLineNo">026</span>@Bean(pr
<TRUNCATED>
