You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/01/18 19:34:47 UTC
[11/33] juneau-website git commit: Update javadocs.
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/60d9bd65/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/License.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/License.html b/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/License.html
index 5d07e47..1225fe6 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/License.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/License.html
@@ -20,41 +20,41 @@
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.dto.swagger;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
-<span class="sourceLineNo">015</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.15"></a>
-<span class="sourceLineNo">016</span><a name="line.16"></a>
-<span class="sourceLineNo">017</span>import java.net.*;<a name="line.17"></a>
-<span class="sourceLineNo">018</span>import java.net.URI;<a name="line.18"></a>
-<span class="sourceLineNo">019</span><a name="line.19"></a>
-<span class="sourceLineNo">020</span>import org.apache.juneau.*;<a name="line.20"></a>
-<span class="sourceLineNo">021</span>import org.apache.juneau.annotation.*;<a name="line.21"></a>
-<span class="sourceLineNo">022</span><a name="line.22"></a>
-<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
-<span class="sourceLineNo">024</span> * License information for the exposed API.<a name="line.24"></a>
-<span class="sourceLineNo">025</span> * <a name="line.25"></a>
-<span class="sourceLineNo">026</span> * <h5 class='section'>Example:</h5><a name="line.26"></a>
-<span class="sourceLineNo">027</span> * <p class='bcode'><a name="line.27"></a>
-<span class="sourceLineNo">028</span> * {<a name="line.28"></a>
-<span class="sourceLineNo">029</span> * <js>"name"</js>: <js>"Apache 2.0"</js>,<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * <js>"url"</js>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js><a name="line.30"></a>
-<span class="sourceLineNo">031</span> * }<a name="line.31"></a>
-<span class="sourceLineNo">032</span> * </p><a name="line.32"></a>
-<span class="sourceLineNo">033</span> * <a name="line.33"></a>
-<span class="sourceLineNo">034</span> * <h6 class='topic'>Additional Information</h6><a name="line.34"></a>
-<span class="sourceLineNo">035</span> * <ul class='doctree'><a name="line.35"></a>
-<span class="sourceLineNo">036</span> * <li class='link'><a name="line.36"></a>
-<span class="sourceLineNo">037</span> * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * (org.apache.juneau.dto)</a><a name="line.38"></a>
-<span class="sourceLineNo">039</span> * <ul><a name="line.39"></a>
-<span class="sourceLineNo">040</span> * <li class='sublink'><a name="line.40"></a>
-<span class="sourceLineNo">041</span> * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a><a name="line.41"></a>
-<span class="sourceLineNo">042</span> * </ul><a name="line.42"></a>
-<span class="sourceLineNo">043</span> * </li><a name="line.43"></a>
-<span class="sourceLineNo">044</span> * <li class='jp'><a name="line.44"></a>
-<span class="sourceLineNo">045</span> * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a><a name="line.45"></a>
-<span class="sourceLineNo">046</span> * </li><a name="line.46"></a>
+<span class="sourceLineNo">015</span>import static org.apache.juneau.internal.BeanPropertyUtils.*;<a name="line.15"></a>
+<span class="sourceLineNo">016</span>import java.net.*;<a name="line.16"></a>
+<span class="sourceLineNo">017</span>import java.net.URI;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import org.apache.juneau.*;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * License information for the exposed API.<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * <a name="line.24"></a>
+<span class="sourceLineNo">025</span> * <h5 class='section'>Example:</h5><a name="line.25"></a>
+<span class="sourceLineNo">026</span> * <p class='bcode'><a name="line.26"></a>
+<span class="sourceLineNo">027</span> * <jc>// Construct using SwaggerBuilder.</jc><a name="line.27"></a>
+<span class="sourceLineNo">028</span> * License x = <jsm>license</jsm>(<js>"Apache 2.0"</js>, <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>);<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * <a name="line.29"></a>
+<span class="sourceLineNo">030</span> * <jc>// Serialize using JsonSerializer.</jc><a name="line.30"></a>
+<span class="sourceLineNo">031</span> * String json = JsonSerializer.<jsf>DEFAULT</jsf>.toString(x);<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * <a name="line.32"></a>
+<span class="sourceLineNo">033</span> * <jc>// Or just use toString() which does the same as above.</jc><a name="line.33"></a>
+<span class="sourceLineNo">034</span> * String json = x.toString();<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * </p><a name="line.35"></a>
+<span class="sourceLineNo">036</span> * <p class='bcode'><a name="line.36"></a>
+<span class="sourceLineNo">037</span> * <jc>// Output</jc><a name="line.37"></a>
+<span class="sourceLineNo">038</span> * {<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * <js>"name"</js>: <js>"Apache 2.0"</js>,<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * <js>"url"</js>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js><a name="line.40"></a>
+<span class="sourceLineNo">041</span> * }<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * </p><a name="line.42"></a>
+<span class="sourceLineNo">043</span> * <a name="line.43"></a>
+<span class="sourceLineNo">044</span> * <h6 class='topic'>Additional Information</h6><a name="line.44"></a>
+<span class="sourceLineNo">045</span> * <ul class='doctree'><a name="line.45"></a>
+<span class="sourceLineNo">046</span> * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-dto.Swagger'>Overview > juneau-dto > Swagger</a><a name="line.46"></a>
<span class="sourceLineNo">047</span> * </ul><a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
-<span class="sourceLineNo">049</span>@Bean(properties="name,url")<a name="line.49"></a>
+<span class="sourceLineNo">049</span>@Bean(properties="name,url,*")<a name="line.49"></a>
<span class="sourceLineNo">050</span>public class License extends SwaggerElement {<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private String name;<a name="line.52"></a>
@@ -64,9 +64,9 @@
<span class="sourceLineNo">056</span> * Bean property getter: <property>name</property>.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * <a name="line.57"></a>
<span class="sourceLineNo">058</span> * <p><a name="line.58"></a>
-<span class="sourceLineNo">059</span> * Required. The license name used for the API.<a name="line.59"></a>
+<span class="sourceLineNo">059</span> * The license name used for the API.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * <a name="line.60"></a>
-<span class="sourceLineNo">061</span> * @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.61"></a>
+<span class="sourceLineNo">061</span> * @return The property value, or <jk>null</jk> if it is not set.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public String getName() {<a name="line.63"></a>
<span class="sourceLineNo">064</span> return name;<a name="line.64"></a>
@@ -76,73 +76,104 @@
<span class="sourceLineNo">068</span> * Bean property setter: <property>name</property>.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * <a name="line.69"></a>
<span class="sourceLineNo">070</span> * <p><a name="line.70"></a>
-<span class="sourceLineNo">071</span> * Required. The license name used for the API.<a name="line.71"></a>
+<span class="sourceLineNo">071</span> * The license name used for the API.<a name="line.71"></a>
<span class="sourceLineNo">072</span> * <a name="line.72"></a>
-<span class="sourceLineNo">073</span> * @param name The new value for the <property>name</property> property on this bean.<a name="line.73"></a>
-<span class="sourceLineNo">074</span> * @return This object (for method chaining).<a name="line.74"></a>
-<span class="sourceLineNo">075</span> */<a name="line.75"></a>
-<span class="sourceLineNo">076</span> public License setName(String name) {<a name="line.76"></a>
-<span class="sourceLineNo">077</span> this.name = name;<a name="line.77"></a>
-<span class="sourceLineNo">078</span> return this;<a name="line.78"></a>
-<span class="sourceLineNo">079</span> }<a name="line.79"></a>
-<span class="sourceLineNo">080</span><a name="line.80"></a>
-<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
-<span class="sourceLineNo">082</span> * Synonym for {@link #setName(String)}.<a name="line.82"></a>
-<span class="sourceLineNo">083</span> * <a name="line.83"></a>
-<span class="sourceLineNo">084</span> * @param name The new value for the <property>name</property> property on this bean.<a name="line.84"></a>
-<span class="sourceLineNo">085</span> * @return This object (for method chaining).<a name="line.85"></a>
-<span class="sourceLineNo">086</span> */<a name="line.86"></a>
-<span class="sourceLineNo">087</span> public License name(String name) {<a name="line.87"></a>
-<span class="sourceLineNo">088</span> return setName(name);<a name="line.88"></a>
-<span class="sourceLineNo">089</span> }<a name="line.89"></a>
-<span class="sourceLineNo">090</span><a name="line.90"></a>
-<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
-<span class="sourceLineNo">092</span> * Bean property getter: <property>url</property>.<a name="line.92"></a>
-<span class="sourceLineNo">093</span> * <a name="line.93"></a>
-<span class="sourceLineNo">094</span> * <p><a name="line.94"></a>
-<span class="sourceLineNo">095</span> * A URL to the license used for the API.<a name="line.95"></a>
-<span class="sourceLineNo">096</span> * <a name="line.96"></a>
-<span class="sourceLineNo">097</span> * <p><a name="line.97"></a>
-<span class="sourceLineNo">098</span> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.<a name="line.98"></a>
-<span class="sourceLineNo">099</span> * Strings must be valid URIs.<a name="line.99"></a>
-<span class="sourceLineNo">100</span> * <a name="line.100"></a>
-<span class="sourceLineNo">101</span> * <p><a name="line.101"></a>
-<span class="sourceLineNo">102</span> * URIs defined by {@link UriResolver} can be used for values.<a name="line.102"></a>
-<span class="sourceLineNo">103</span> * <a name="line.103"></a>
-<span class="sourceLineNo">104</span> * @return The value of the <property>url</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.104"></a>
-<span class="sourceLineNo">105</span> */<a name="line.105"></a>
-<span class="sourceLineNo">106</span> public URI getUrl() {<a name="line.106"></a>
-<span class="sourceLineNo">107</span> return url;<a name="line.107"></a>
-<span class="sourceLineNo">108</span> }<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> * Bean property setter: <property>url</property>.<a name="line.111"></a>
-<span class="sourceLineNo">112</span> * <a name="line.112"></a>
-<span class="sourceLineNo">113</span> * <p><a name="line.113"></a>
-<span class="sourceLineNo">114</span> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.<a name="line.114"></a>
-<span class="sourceLineNo">115</span> * Strings must be valid URIs.<a name="line.115"></a>
-<span class="sourceLineNo">116</span> * <a name="line.116"></a>
-<span class="sourceLineNo">117</span> * <p><a name="line.117"></a>
-<span class="sourceLineNo">118</span> * URIs defined by {@link UriResolver} can be used for values.<a name="line.118"></a>
-<span class="sourceLineNo">119</span> * <a name="line.119"></a>
-<span class="sourceLineNo">120</span> * @param url The new value for the <property>url</property> property on this bean.<a name="line.120"></a>
-<span class="sourceLineNo">121</span> * @return This object (for method chaining).<a name="line.121"></a>
-<span class="sourceLineNo">122</span> */<a name="line.122"></a>
-<span class="sourceLineNo">123</span> public License setUrl(Object url) {<a name="line.123"></a>
-<span class="sourceLineNo">124</span> this.url = toURI(url);<a name="line.124"></a>
-<span class="sourceLineNo">125</span> return this;<a name="line.125"></a>
-<span class="sourceLineNo">126</span> }<a name="line.126"></a>
-<span class="sourceLineNo">127</span><a name="line.127"></a>
-<span class="sourceLineNo">128</span> /**<a name="line.128"></a>
-<span class="sourceLineNo">129</span> * Synonym for {@link #setUrl(Object)}.<a name="line.129"></a>
-<span class="sourceLineNo">130</span> * <a name="line.130"></a>
-<span class="sourceLineNo">131</span> * @param url The new value for the <property>url</property> property on this bean.<a name="line.131"></a>
-<span class="sourceLineNo">132</span> * @return This object (for method chaining).<a name="line.132"></a>
-<span class="sourceLineNo">133</span> */<a name="line.133"></a>
-<span class="sourceLineNo">134</span> public License url(Object url) {<a name="line.134"></a>
-<span class="sourceLineNo">135</span> return setUrl(url);<a name="line.135"></a>
-<span class="sourceLineNo">136</span> }<a name="line.136"></a>
-<span class="sourceLineNo">137</span>}<a name="line.137"></a>
+<span class="sourceLineNo">073</span> * @param value <a name="line.73"></a>
+<span class="sourceLineNo">074</span> * The new value for this property.<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * <br>Property value is required.<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * @return This object (for method chaining).<a name="line.76"></a>
+<span class="sourceLineNo">077</span> */<a name="line.77"></a>
+<span class="sourceLineNo">078</span> public License setName(String value) {<a name="line.78"></a>
+<span class="sourceLineNo">079</span> name = value;<a name="line.79"></a>
+<span class="sourceLineNo">080</span> return this;<a name="line.80"></a>
+<span class="sourceLineNo">081</span> }<a name="line.81"></a>
+<span class="sourceLineNo">082</span><a name="line.82"></a>
+<span class="sourceLineNo">083</span> /**<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * Same as {@link #setName(String)}.<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * <a name="line.85"></a>
+<span class="sourceLineNo">086</span> * @param value<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * The new value for this property.<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * <br>Non-String values will be converted to String using <code>toString()</code>.<a name="line.88"></a>
+<span class="sourceLineNo">089</span> * <br>Can be <jk>null</jk> to unset the property.<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * @return This object (for method chaining).<a name="line.90"></a>
+<span class="sourceLineNo">091</span> */<a name="line.91"></a>
+<span class="sourceLineNo">092</span> public License name(Object value) {<a name="line.92"></a>
+<span class="sourceLineNo">093</span> return setName(toStringVal(value));<a name="line.93"></a>
+<span class="sourceLineNo">094</span> }<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> * Bean property getter: <property>url</property>.<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * <a name="line.98"></a>
+<span class="sourceLineNo">099</span> * <p><a name="line.99"></a>
+<span class="sourceLineNo">100</span> * A URL to the license used for the API.<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * <a name="line.101"></a>
+<span class="sourceLineNo">102</span> * @return The property value, or <jk>null</jk> if it is not set.<a name="line.102"></a>
+<span class="sourceLineNo">103</span> */<a name="line.103"></a>
+<span class="sourceLineNo">104</span> public URI getUrl() {<a name="line.104"></a>
+<span class="sourceLineNo">105</span> return url;<a name="line.105"></a>
+<span class="sourceLineNo">106</span> }<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * Bean property setter: <property>url</property>.<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * <a name="line.110"></a>
+<span class="sourceLineNo">111</span> * <p><a name="line.111"></a>
+<span class="sourceLineNo">112</span> * A URL to the license used for the API.<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * <a name="line.113"></a>
+<span class="sourceLineNo">114</span> * @param value <a name="line.114"></a>
+<span class="sourceLineNo">115</span> * The new value for this property.<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * <br>URIs defined by {@link UriResolver} can be used for values.<a name="line.116"></a>
+<span class="sourceLineNo">117</span> * <br>Can be <jk>null</jk> to unset the property.<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * @return This object (for method chaining).<a name="line.118"></a>
+<span class="sourceLineNo">119</span> */<a name="line.119"></a>
+<span class="sourceLineNo">120</span> public License setUrl(URI value) {<a name="line.120"></a>
+<span class="sourceLineNo">121</span> url = value;<a name="line.121"></a>
+<span class="sourceLineNo">122</span> return this;<a name="line.122"></a>
+<span class="sourceLineNo">123</span> }<a name="line.123"></a>
+<span class="sourceLineNo">124</span><a name="line.124"></a>
+<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * Same as {@link #setUrl(URI)}.<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * <a name="line.127"></a>
+<span class="sourceLineNo">128</span> * @param value<a name="line.128"></a>
+<span class="sourceLineNo">129</span> * The new value for this property.<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * <br>Non-URI values will be converted to URI using <code><jk>new</jk> URI(value.toString())</code>.<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * <br>Valid types:<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * <ul><a name="line.132"></a>
+<span class="sourceLineNo">133</span> * <li>{@link URI}<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * <li>{@link URL}<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * <li>{@link String}<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * <br>Converted to a URI using <code>URI.<jsm>create</jsm>(value.toString())</code><a name="line.136"></a>
+<span class="sourceLineNo">137</span> * </ul><a name="line.137"></a>
+<span class="sourceLineNo">138</span> * <br>Can be <jk>null</jk> to unset the property.<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * @return This object (for method chaining).<a name="line.139"></a>
+<span class="sourceLineNo">140</span> */<a name="line.140"></a>
+<span class="sourceLineNo">141</span> public License url(Object value) {<a name="line.141"></a>
+<span class="sourceLineNo">142</span> return setUrl(toURI(value));<a name="line.142"></a>
+<span class="sourceLineNo">143</span> }<a name="line.143"></a>
+<span class="sourceLineNo">144</span><a name="line.144"></a>
+<span class="sourceLineNo">145</span> @Override /* SwaggerElement */<a name="line.145"></a>
+<span class="sourceLineNo">146</span> public <T> T get(String property, Class<T> type) {<a name="line.146"></a>
+<span class="sourceLineNo">147</span> if (property == null)<a name="line.147"></a>
+<span class="sourceLineNo">148</span> return null;<a name="line.148"></a>
+<span class="sourceLineNo">149</span> switch (property) {<a name="line.149"></a>
+<span class="sourceLineNo">150</span> case "name": return toType(getName(), type);<a name="line.150"></a>
+<span class="sourceLineNo">151</span> case "url": return toType(getUrl(), type);<a name="line.151"></a>
+<span class="sourceLineNo">152</span> default: return super.get(property, type);<a name="line.152"></a>
+<span class="sourceLineNo">153</span> }<a name="line.153"></a>
+<span class="sourceLineNo">154</span> }<a name="line.154"></a>
+<span class="sourceLineNo">155</span><a name="line.155"></a>
+<span class="sourceLineNo">156</span> @Override /* SwaggerElement */<a name="line.156"></a>
+<span class="sourceLineNo">157</span> public License set(String property, Object value) {<a name="line.157"></a>
+<span class="sourceLineNo">158</span> if (property == null)<a name="line.158"></a>
+<span class="sourceLineNo">159</span> return this;<a name="line.159"></a>
+<span class="sourceLineNo">160</span> switch (property) {<a name="line.160"></a>
+<span class="sourceLineNo">161</span> case "name": return name(value);<a name="line.161"></a>
+<span class="sourceLineNo">162</span> case "url": return url(value);<a name="line.162"></a>
+<span class="sourceLineNo">163</span> default: <a name="line.163"></a>
+<span class="sourceLineNo">164</span> super.set(property, value);<a name="line.164"></a>
+<span class="sourceLineNo">165</span> return this;<a name="line.165"></a>
+<span class="sourceLineNo">166</span> }<a name="line.166"></a>
+<span class="sourceLineNo">167</span> }<a name="line.167"></a>
+<span class="sourceLineNo">168</span>}<a name="line.168"></a>