| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.http.annotation;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><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>import org.apache.juneau.httppart.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.juneau.oapi.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * REST request form-data annotation.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> *<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <p><a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * Identifies a POJO to be used as a form-data entry on an HTTP request.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> *<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <p><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Can be used in the following locations:<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <ul><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <li>Arguments and argument-types of server-side <ja>@RestOp</ja>-annotated methods.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <li>Arguments and argument-types of client-side <ja>@RemoteResource</ja>-annotated interfaces.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <li>Methods and return types of server-side and client-side <ja>@Request</ja>-annotated interfaces.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * </ul><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> *<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <h5 class='topic'>Arguments and argument-types of server-side @RestOp-annotated methods</h5><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Annotation that can be applied to a parameter of a <ja>@RestOp</ja>-annotated method to identify it as a URL query parameter.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p class='w800'><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Unlike {@link FormData @FormData}, using this annotation does not result in the servlet reading the contents of<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * URL-encoded form posts.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Therefore, this annotation can be used in conjunction with the {@link Content @Content} annotation or<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <c>RestRequest.getContent()</c> method for <c>application/x-www-form-urlencoded POST</c> calls.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <h5 class='section'>Example:</h5><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <p class='bjava'><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <ja>@RestGet</ja><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <jk>public void</jk> doGet(<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <ja>@Query</ja>(<js>"p1"</js>) <jk>int</jk> <jv>p1</jv>,<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <ja>@Query</ja>(<js>"p2"</js>) String <jv>p2</jv>,<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <ja>@Query</ja>(<js>"p3"</js>) UUID <jv>p3</jv><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * ) {...}<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * </p><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> * This is functionally equivalent to the following code...<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <p class='bjava'><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <ja>@RestGet</ja><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <jk>public void</jk> doGet(RestRequest <jv>req</jv>, RestResponse <jv>res</jv>) {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <jk>int</jk> <jv>p1</jv> = <jv>req</jv>.getQueryParam(<js>"p1"</js>).asInteger().orElse(0);<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * String <jv>p2</jv> = <jv>req</jv>.getQueryParam(<js>"p2"</js>).asString().orElse(<jk>null</jk>);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * UUID <jv>p3</jv> = <jv>req</jv>.getQueryParam(<js>"p3"</js>).as(UUID.<jk>class</jk>).orElse(<jk>null</jk>);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * ...<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * </p><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <ul class='seealso'><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <li class='link'>{@doc jrs.Swagger}<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <li class='extlink'>{@doc ext.SwaggerParameterObject}<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * </ul><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> *<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <h5 class='topic'>Arguments and argument-types of client-side @RemoteResource-annotated interfaces</h5><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <p><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * <ul class='seealso'><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <li class='link'>{@doc jrc.Query}<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * </ul><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> *<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <h5 class='topic'>Methods and return types of server-side and client-side @Request-annotated interfaces</h5><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <p><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * <ul class='seealso'><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <li class='link'>{@doc jrc.Request}<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * </ul><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <p><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <ul class='seealso'><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <li class='extlink'>{@source}<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * </ul><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span>@Documented<a name="line.91"></a> |
| <span class="sourceLineNo">092</span>@Target({PARAMETER,METHOD,TYPE,FIELD})<a name="line.92"></a> |
| <span class="sourceLineNo">093</span>@Retention(RUNTIME)<a name="line.93"></a> |
| <span class="sourceLineNo">094</span>@Inherited<a name="line.94"></a> |
| <span class="sourceLineNo">095</span>@Repeatable(QueryAnnotation.Array.class)<a name="line.95"></a> |
| <span class="sourceLineNo">096</span>@ContextApply(QueryAnnotation.Applier.class)<a name="line.96"></a> |
| <span class="sourceLineNo">097</span>public @interface Query {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Default value for this parameter.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> *<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @return The annotation value.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> String def() default "";<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * URL query parameter name.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Required. The name of the parameter. Parameter names are case sensitive.<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> * The value should be either a valid query parameter name, or <js>"*"</js> to represent multiple name/value pairs<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * <p><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * A blank value (the default) has the following behavior:<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * <ul class='spaced-list'><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * <li><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * If the data type is <c>NameValuePairs</c>, <c>Map</c>, or a bean,<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * then it's the equivalent to <js>"*"</js> which will cause the value to be serialized as name/value pairs.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> *<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * <h5 class='figure'>Examples:</h5><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * <p class='bjava'><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * <jc>// When used on a REST method</jc><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * <ja>@RestPost</ja><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <jk>public void</jk> addPet(<ja>@Query</ja> JsonMap <jv>allQueryParameters</jv>) {...}<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * </p><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * <p class='bjava'><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * <jc>// When used on a remote method parameter</jc><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * <ja>@RemoteResource</ja>(path=<js>"/myproxy"</js>)<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * <jk>public interface</jk> MyProxy {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> *<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * <jc>// Equivalent to @Query("*")</jc><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * <ja>@RemoteGet</ja>(<js>"/mymethod"</js>)<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * String myProxyMethod1(<ja>@Query</ja> Map&lt;String,Object&gt; <jv>allQueryParameters</jv>);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * </p><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * <p class='bjava'><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * <jc>// When used on a request bean method</jc><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * <jk>public interface</jk> MyRequest {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> *<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * <jc>// Equivalent to @Query("*")</jc><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * <ja>@Query</ja><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * Map&lt;String,Object&gt; getFoo();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * }<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * </p><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * </li><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * <li><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * If used on a request bean method, uses the bean property name.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> *<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * <h5 class='figure'>Example:</h5><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * <p class='bjava'><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * <jk>public interface</jk> MyRequest {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> *<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * <jc>// Equivalent to @Query("foo")</jc><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * <ja>@Query</ja><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * String getFoo();<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * </p><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * </li><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * </ul><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * <ul class='notes'><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * <li class='note'><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * The format is plain-text.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * </ul><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> *<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @return The annotation value.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> String name() default "";<a name="line.168"></a> |
| <span class="sourceLineNo">169</span><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> /**<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * Dynamically apply this annotation to the specified classes.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> *<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * <ul class='seealso'><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * <li class='link'>{@doc jm.DynamicallyAppliedAnnotations}<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * </ul><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> *<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @return The annotation value.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> */<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> String[] on() default {};<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Dynamically apply this annotation to the specified classes.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> *<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * <p><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * Identical to {@link #on()} except allows you to specify class objects instead of a strings.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> *<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * <ul class='seealso'><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * <li class='link'>{@doc jm.DynamicallyAppliedAnnotations}<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * </ul><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> *<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @return The annotation value.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> */<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> Class<?>[] onClass() default {};<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> /**<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * Specifies the {@link HttpPartParser} class used for parsing strings to values.<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> *<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * <p><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * Overrides for this part the part parser defined on the REST resource which by default is {@link OpenApiParser}.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> *<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @return The annotation value.<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> */<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> Class<? extends HttpPartParser> parser() default HttpPartParser.Void.class;<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * <mk>schema</mk> field of the {@doc ext.SwaggerParameterObject}.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> *<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * <p><a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * The {@link Schema @Schema} annotation can also be used standalone on the parameter or type.<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * Values specified on this field override values specified on the type, and values specified on child types override values<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * specified on parent types.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> *<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * <p><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * The schema defining the type used for parameter.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> *<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * <h5 class='section'>Used for:</h5><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * <ul class='spaced-list'><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * <li><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * Server-side schema-based parsing and parsing validation.<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * <li><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * Server-side generated Swagger documentation.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * <li><a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * Client-side schema-based serializing and serializing validation.<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * </ul><a name="line.224"></a> |
| <span class="sourceLineNo">225</span> *<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @return The annotation value.<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> */<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> Schema schema() default @Schema;<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> * Specifies the {@link HttpPartSerializer} class used for serializing values to strings.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> *<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * <p><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * Overrides for this part the part serializer defined on the REST client which by default is {@link OpenApiSerializer}.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> *<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @return The annotation value.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> */<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> Class<? extends HttpPartSerializer> serializer() default HttpPartSerializer.Void.class;<a name="line.238"></a> |
| <span class="sourceLineNo">239</span><a name="line.239"></a> |
| <span class="sourceLineNo">240</span> /**<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * A synonym for {@link #name()}.<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> *<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * <p><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * Allows you to use shortened notation if you're only specifying the name.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> *<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * <p><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * The following are completely equivalent ways of defining the existence of a query entry:<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * <p class='bjava'><a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * <jk>public</jk> Order placeOrder(<ja>@Query</ja>(name=<js>"petId"</js>) <jk>long</jk> <jv>petId</jv>) {...}<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * </p><a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * <p class='bjava'><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * <jk>public</jk> Order placeOrder(<ja>@Query</ja>(<js>"petId"</js>) <jk>long</jk> <jv>petId</jv>) {...}<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * </p><a name="line.253"></a> |
| <span class="sourceLineNo">254</span> *<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * @return The annotation value.<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> */<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> String value() default "";<a name="line.257"></a> |
| <span class="sourceLineNo">258</span>}<a name="line.258"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |