Google Git
Sign in
apache / juneau-website / 3ec6a38af8eff23af4011afbc4a002edec02bd97 / . / content / site / apidocs-9.0.0 / src-html / org / apache / juneau / http / annotation / FormData.html
blob: fbf4b38371a21b36087fa57449bfbaa79b99d6c3 [file] [log] [blame]
<!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> * &lt;p&gt;<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> * &lt;p&gt;<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> * &lt;ul&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;li&gt;Arguments and argument-types of server-side &lt;ja&gt;@RestOp&lt;/ja&gt;-annotated methods.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;li&gt;Arguments and argument-types of client-side &lt;ja&gt;@RemoteResource&lt;/ja&gt;-annotated interfaces.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;li&gt;Methods and return types of server-side and client-side &lt;ja&gt;@Request&lt;/ja&gt;-annotated interfaces.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;/ul&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;h5 class='topic'&gt;Arguments and argument-types of server-side @RestOp-annotated methods&lt;/h5&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Annotation that can be applied to a parameter of a &lt;ja&gt;@RestOp&lt;/ja&gt;-annotated method to identify it as a form-data parameter.<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;p class='bjava'&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;ja&gt;@RestPost&lt;/ja&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;jk&gt;public void&lt;/jk&gt; doPost(<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;ja&gt;@FormData&lt;/ja&gt;(&lt;js&gt;"p1"&lt;/js&gt;) &lt;jk&gt;int&lt;/jk&gt; &lt;jv&gt;p1&lt;/jv&gt;,<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;ja&gt;@FormData&lt;/ja&gt;(&lt;js&gt;"p2"&lt;/js&gt;) String &lt;jv&gt;p2&lt;/jv&gt;,<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;ja&gt;@FormData&lt;/ja&gt;(&lt;js&gt;"p3"&lt;/js&gt;) UUID &lt;jv&gt;p3&lt;/jv&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * ) {...}<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;/p&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;p&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * This is functionally equivalent to the following code...<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;p class='bjava'&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;ja&gt;@RestPost&lt;/ja&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;jk&gt;public void&lt;/jk&gt; doPost(RestRequest &lt;jv&gt;req&lt;/jv&gt;) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;jk&gt;int&lt;/jk&gt; &lt;jv&gt;p1&lt;/jv&gt; = &lt;jv&gt;req&lt;/jv&gt;.getFormParam(&lt;js&gt;"p1"&lt;/js&gt;).as(&lt;jk&gt;int&lt;/jk&gt;.&lt;jk&gt;class&lt;/jk&gt;).orElse(0);<a name="line.57"></a>
<span class="sourceLineNo">058</span> * String &lt;jv&gt;p2&lt;/jv&gt; = &lt;jv&gt;req&lt;/jv&gt;.getFormParam(&lt;js&gt;"p2"&lt;/js&gt;).asString().orElse(&lt;jk&gt;null&lt;/jk&gt;);<a name="line.58"></a>
<span class="sourceLineNo">059</span> * UUID &lt;jv&gt;p3&lt;/jv&gt; = &lt;jv&gt;req&lt;/jv&gt;.getFormParam(&lt;js&gt;"p3"&lt;/js&gt;).as(UUID.&lt;jk&gt;class&lt;/jk&gt;).orElse(&lt;jk&gt;null&lt;/jk&gt;);<a name="line.59"></a>
<span class="sourceLineNo">060</span> * ...<a name="line.60"></a>
<span class="sourceLineNo">061</span> * }<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;/p&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> *<a name="line.63"></a>
<span class="sourceLineNo">064</span> * &lt;ul class='seealso'&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;li class='link'&gt;{@doc jrs.Swagger}<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;li class='extlink'&gt;{@doc ext.SwaggerParameterObject}<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;/ul&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;h5 class='topic'&gt;Important note concerning FORM posts&lt;/h5&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;p&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * This annotation should not be combined with the {@link Content @Content} annotation or &lt;c&gt;RestRequest.getContent()&lt;/c&gt; method<a name="line.71"></a>
<span class="sourceLineNo">072</span> * for &lt;c&gt;application/x-www-form-urlencoded POST&lt;/c&gt; posts, since it will trigger the underlying servlet<a name="line.72"></a>
<span class="sourceLineNo">073</span> * API to parse the body content as key-value pairs resulting in empty content.<a name="line.73"></a>
<span class="sourceLineNo">074</span> *<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;p&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * The {@link Query @Query} annotation can be used to retrieve a URL parameter in the URL string without triggering the<a name="line.76"></a>
<span class="sourceLineNo">077</span> * servlet to drain the body content.<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;h5 class='topic'&gt;Arguments and argument-types of client-side @RemoteResource-annotated interfaces&lt;/h5&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;p&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * Annotation applied to Java method arguments of interface proxies to denote that they are FORM post parameters on the<a name="line.81"></a>
<span class="sourceLineNo">082</span> * request.<a name="line.82"></a>
<span class="sourceLineNo">083</span> *<a name="line.83"></a>
<span class="sourceLineNo">084</span> * &lt;ul class='seealso'&gt;<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &lt;li class='link'&gt;{@doc jrc.FormData}<a name="line.85"></a>
<span class="sourceLineNo">086</span> * &lt;li class='link'&gt;{@doc jrc.Request}<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;/ul&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> *<a name="line.88"></a>
<span class="sourceLineNo">089</span> * &lt;h5 class='topic'&gt;Methods and return types of server-side and client-side @Request-annotated interfaces&lt;/h5&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;p&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;ul class='seealso'&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;li class='link'&gt;{@doc jrc.Request}<a name="line.92"></a>
<span class="sourceLineNo">093</span> * &lt;/ul&gt;<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * &lt;div class='warn'&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span> * This annotation should not be combined with the {@link Content @Content} annotation or &lt;c&gt;RestRequest#getContent()&lt;/c&gt; method<a name="line.96"></a>
<span class="sourceLineNo">097</span> * for &lt;c&gt;application/x-www-form-urlencoded POST&lt;/c&gt; posts, since it will trigger the underlying servlet<a name="line.97"></a>
<span class="sourceLineNo">098</span> * API to parse the body content as key-value pairs resulting in empty content.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &lt;br&gt;The {@link Query @Query} annotation can be used to retrieve a URL parameter in the URL string without triggering the<a name="line.99"></a>
<span class="sourceLineNo">100</span> * servlet to drain the body content.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * &lt;/div&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span> * &lt;div class='warn'&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span> * If using this annotation on a Spring bean, note that you are likely to encounter issues when using on parameterized<a name="line.103"></a>
<span class="sourceLineNo">104</span> * types such as &lt;code&gt;List&amp;lt;MyBean&amp;gt;&lt;/code&gt;. This is due to the fact that Spring uses CGLIB to recompile classes<a name="line.104"></a>
<span class="sourceLineNo">105</span> * at runtime, and CGLIB was written before generics were introduced into Java and is a virtually-unsupported library.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Therefore, parameterized types will often be stripped from class definitions and replaced with unparameterized types<a name="line.106"></a>
<span class="sourceLineNo">107</span> * (e.g. &lt;code&gt;List&lt;/code&gt;). Under these circumstances, you are likely to get &lt;code&gt;ClassCastExceptions&lt;/code&gt;<a name="line.107"></a>
<span class="sourceLineNo">108</span> * when trying to access generalized &lt;code&gt;JsonMaps&lt;/code&gt; as beans. The best solution to this issue is to either<a name="line.108"></a>
<span class="sourceLineNo">109</span> * specify the parameter as a bean array (e.g. &lt;code&gt;MyBean[]&lt;/code&gt;) or declare the method as final so that CGLIB<a name="line.109"></a>
<span class="sourceLineNo">110</span> * will not try to recompile it.<a name="line.110"></a>
<span class="sourceLineNo">111</span> * &lt;/div&gt;<a name="line.111"></a>
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
<span class="sourceLineNo">113</span> * &lt;ul class='seealso'&gt;<a name="line.113"></a>
<span class="sourceLineNo">114</span> * &lt;li class='extlink'&gt;{@source}<a name="line.114"></a>
<span class="sourceLineNo">115</span> * &lt;/ul&gt;<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span>@Documented<a name="line.117"></a>
<span class="sourceLineNo">118</span>@Target({PARAMETER,METHOD,TYPE,FIELD})<a name="line.118"></a>
<span class="sourceLineNo">119</span>@Retention(RUNTIME)<a name="line.119"></a>
<span class="sourceLineNo">120</span>@Inherited<a name="line.120"></a>
<span class="sourceLineNo">121</span>@Repeatable(FormDataAnnotation.Array.class)<a name="line.121"></a>
<span class="sourceLineNo">122</span>@ContextApply(FormDataAnnotation.Applier.class)<a name="line.122"></a>
<span class="sourceLineNo">123</span>public @interface FormData {<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> * Default value for this parameter.<a name="line.126"></a>
<span class="sourceLineNo">127</span> *<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @return The annotation value.<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> String def() default "";<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
<span class="sourceLineNo">133</span> * FORM parameter name.<a name="line.133"></a>
<span class="sourceLineNo">134</span> *<a name="line.134"></a>
<span class="sourceLineNo">135</span> * &lt;p&gt;<a name="line.135"></a>
<span class="sourceLineNo">136</span> * The name of the parameter (required).<a name="line.136"></a>
<span class="sourceLineNo">137</span> *<a name="line.137"></a>
<span class="sourceLineNo">138</span> * &lt;p&gt;<a name="line.138"></a>
<span class="sourceLineNo">139</span> * The value should be either a valid form parameter name, or &lt;js&gt;"*"&lt;/js&gt; to represent multiple name/value pairs<a name="line.139"></a>
<span class="sourceLineNo">140</span> *<a name="line.140"></a>
<span class="sourceLineNo">141</span> * &lt;p&gt;<a name="line.141"></a>
<span class="sourceLineNo">142</span> * A blank value (the default) has the following behavior:<a name="line.142"></a>
<span class="sourceLineNo">143</span> * &lt;ul class='spaced-list'&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span> * &lt;li&gt;<a name="line.144"></a>
<span class="sourceLineNo">145</span> * If the data type is &lt;c&gt;NameValuePairs&lt;/c&gt;, &lt;c&gt;Map&lt;/c&gt;, or a bean,<a name="line.145"></a>
<span class="sourceLineNo">146</span> * then it's the equivalent to &lt;js&gt;"*"&lt;/js&gt; which will cause the value to be serialized as name/value pairs.<a name="line.146"></a>
<span class="sourceLineNo">147</span> *<a name="line.147"></a>
<span class="sourceLineNo">148</span> * &lt;h5 class='figure'&gt;Examples:&lt;/h5&gt;<a name="line.148"></a>
<span class="sourceLineNo">149</span> * &lt;p class='bjava'&gt;<a name="line.149"></a>
<span class="sourceLineNo">150</span> * &lt;jc&gt;// When used on a REST method&lt;/jc&gt;<a name="line.150"></a>
<span class="sourceLineNo">151</span> * &lt;ja&gt;@RestPost&lt;/ja&gt;(&lt;js&gt;"/addPet"&lt;/js&gt;)<a name="line.151"></a>
<span class="sourceLineNo">152</span> * &lt;jk&gt;public void&lt;/jk&gt; addPet(&lt;ja&gt;@FormData&lt;/ja&gt; JsonMap &lt;jv&gt;allFormDataParameters&lt;/jv&gt;) {...}<a name="line.152"></a>
<span class="sourceLineNo">153</span> * &lt;/p&gt;<a name="line.153"></a>
<span class="sourceLineNo">154</span> * &lt;p class='bjava'&gt;<a name="line.154"></a>
<span class="sourceLineNo">155</span> * &lt;jc&gt;// When used on a remote method parameter&lt;/jc&gt;<a name="line.155"></a>
<span class="sourceLineNo">156</span> * &lt;ja&gt;@RemoteResource&lt;/ja&gt;(path=&lt;js&gt;"/myproxy"&lt;/js&gt;)<a name="line.156"></a>
<span class="sourceLineNo">157</span> * &lt;jk&gt;public interface&lt;/jk&gt; MyProxy {<a name="line.157"></a>
<span class="sourceLineNo">158</span> *<a name="line.158"></a>
<span class="sourceLineNo">159</span> * &lt;jc&gt;// Equivalent to @FormData("*")&lt;/jc&gt;<a name="line.159"></a>
<span class="sourceLineNo">160</span> * &lt;ja&gt;@RemotePost&lt;/ja&gt;(&lt;js&gt;"/mymethod"&lt;/js&gt;)<a name="line.160"></a>
<span class="sourceLineNo">161</span> * String myProxyMethod1(&lt;ja&gt;@FormData&lt;/ja&gt; Map&amp;lt;String,Object&amp;gt; &lt;jv&gt;allFormDataParameters&lt;/jv&gt;);<a name="line.161"></a>
<span class="sourceLineNo">162</span> * }<a name="line.162"></a>
<span class="sourceLineNo">163</span> * &lt;/p&gt;<a name="line.163"></a>
<span class="sourceLineNo">164</span> * &lt;p class='bjava'&gt;<a name="line.164"></a>
<span class="sourceLineNo">165</span> * &lt;jc&gt;// When used on a request bean method&lt;/jc&gt;<a name="line.165"></a>
<span class="sourceLineNo">166</span> * &lt;jk&gt;public interface&lt;/jk&gt; MyRequest {<a name="line.166"></a>
<span class="sourceLineNo">167</span> *<a name="line.167"></a>
<span class="sourceLineNo">168</span> * &lt;jc&gt;// Equivalent to @FormData("*")&lt;/jc&gt;<a name="line.168"></a>
<span class="sourceLineNo">169</span> * &lt;ja&gt;@FormData&lt;/ja&gt;<a name="line.169"></a>
<span class="sourceLineNo">170</span> * Map&amp;lt;String,Object&amp;gt; getFoo();<a name="line.170"></a>
<span class="sourceLineNo">171</span> * }<a name="line.171"></a>
<span class="sourceLineNo">172</span> * &lt;/p&gt;<a name="line.172"></a>
<span class="sourceLineNo">173</span> * &lt;/li&gt;<a name="line.173"></a>
<span class="sourceLineNo">174</span> * &lt;li&gt;<a name="line.174"></a>
<span class="sourceLineNo">175</span> * If used on a request bean method, uses the bean property name.<a name="line.175"></a>
<span class="sourceLineNo">176</span> *<a name="line.176"></a>
<span class="sourceLineNo">177</span> * &lt;h5 class='figure'&gt;Example:&lt;/h5&gt;<a name="line.177"></a>
<span class="sourceLineNo">178</span> * &lt;p class='bjava'&gt;<a name="line.178"></a>
<span class="sourceLineNo">179</span> * &lt;jk&gt;public interface&lt;/jk&gt; MyRequest {<a name="line.179"></a>
<span class="sourceLineNo">180</span> *<a name="line.180"></a>
<span class="sourceLineNo">181</span> * &lt;jc&gt;// Equivalent to @FormData("foo")&lt;/jc&gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span> * &lt;ja&gt;@FormData&lt;/ja&gt;<a name="line.182"></a>
<span class="sourceLineNo">183</span> * String getFoo();<a name="line.183"></a>
<span class="sourceLineNo">184</span> * }<a name="line.184"></a>
<span class="sourceLineNo">185</span> * &lt;/p&gt;<a name="line.185"></a>
<span class="sourceLineNo">186</span> * &lt;/li&gt;<a name="line.186"></a>
<span class="sourceLineNo">187</span> * &lt;/ul&gt;<a name="line.187"></a>
<span class="sourceLineNo">188</span> *<a name="line.188"></a>
<span class="sourceLineNo">189</span> * &lt;ul class='notes'&gt;<a name="line.189"></a>
<span class="sourceLineNo">190</span> * &lt;li class='note'&gt;<a name="line.190"></a>
<span class="sourceLineNo">191</span> * The format is plain-text.<a name="line.191"></a>
<span class="sourceLineNo">192</span> * &lt;/ul&gt;<a name="line.192"></a>
<span class="sourceLineNo">193</span> *<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @return The annotation value.<a name="line.194"></a>
<span class="sourceLineNo">195</span> */<a name="line.195"></a>
<span class="sourceLineNo">196</span> String name() default "";<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> /**<a name="line.198"></a>
<span class="sourceLineNo">199</span> * Dynamically apply this annotation to the specified classes.<a name="line.199"></a>
<span class="sourceLineNo">200</span> *<a name="line.200"></a>
<span class="sourceLineNo">201</span> * &lt;ul class='seealso'&gt;<a name="line.201"></a>
<span class="sourceLineNo">202</span> * &lt;li class='link'&gt;{@doc jm.DynamicallyAppliedAnnotations}<a name="line.202"></a>
<span class="sourceLineNo">203</span> * &lt;/ul&gt;<a name="line.203"></a>
<span class="sourceLineNo">204</span> *<a name="line.204"></a>
<span class="sourceLineNo">205</span> * @return The annotation value.<a name="line.205"></a>
<span class="sourceLineNo">206</span> */<a name="line.206"></a>
<span class="sourceLineNo">207</span> String[] on() default {};<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> /**<a name="line.209"></a>
<span class="sourceLineNo">210</span> * Dynamically apply this annotation to the specified classes.<a name="line.210"></a>
<span class="sourceLineNo">211</span> *<a name="line.211"></a>
<span class="sourceLineNo">212</span> * &lt;p&gt;<a name="line.212"></a>
<span class="sourceLineNo">213</span> * Identical to {@link #on()} except allows you to specify class objects instead of a strings.<a name="line.213"></a>
<span class="sourceLineNo">214</span> *<a name="line.214"></a>
<span class="sourceLineNo">215</span> * &lt;ul class='seealso'&gt;<a name="line.215"></a>
<span class="sourceLineNo">216</span> * &lt;li class='link'&gt;{@doc jm.DynamicallyAppliedAnnotations}<a name="line.216"></a>
<span class="sourceLineNo">217</span> * &lt;/ul&gt;<a name="line.217"></a>
<span class="sourceLineNo">218</span> *<a name="line.218"></a>
<span class="sourceLineNo">219</span> * @return The annotation value.<a name="line.219"></a>
<span class="sourceLineNo">220</span> */<a name="line.220"></a>
<span class="sourceLineNo">221</span> Class&lt;?&gt;[] onClass() default {};<a name="line.221"></a>
<span class="sourceLineNo">222</span><a name="line.222"></a>
<span class="sourceLineNo">223</span> /**<a name="line.223"></a>
<span class="sourceLineNo">224</span> * Specifies the {@link HttpPartParser} class used for parsing strings to values.<a name="line.224"></a>
<span class="sourceLineNo">225</span> *<a name="line.225"></a>
<span class="sourceLineNo">226</span> * &lt;p&gt;<a name="line.226"></a>
<span class="sourceLineNo">227</span> * Overrides for this part the part parser defined on the REST resource which by default is {@link OpenApiParser}.<a name="line.227"></a>
<span class="sourceLineNo">228</span> *<a name="line.228"></a>
<span class="sourceLineNo">229</span> * @return The annotation value.<a name="line.229"></a>
<span class="sourceLineNo">230</span> */<a name="line.230"></a>
<span class="sourceLineNo">231</span> Class&lt;? extends HttpPartParser&gt; parser() default HttpPartParser.Void.class;<a name="line.231"></a>
<span class="sourceLineNo">232</span><a name="line.232"></a>
<span class="sourceLineNo">233</span> /**<a name="line.233"></a>
<span class="sourceLineNo">234</span> * &lt;mk&gt;schema&lt;/mk&gt; field of the {@doc ext.SwaggerParameterObject}.<a name="line.234"></a>
<span class="sourceLineNo">235</span> *<a name="line.235"></a>
<span class="sourceLineNo">236</span> * &lt;p&gt;<a name="line.236"></a>
<span class="sourceLineNo">237</span> * The schema defining the type used for parameter.<a name="line.237"></a>
<span class="sourceLineNo">238</span> *<a name="line.238"></a>
<span class="sourceLineNo">239</span> * &lt;p&gt;<a name="line.239"></a>
<span class="sourceLineNo">240</span> * The {@link Schema @Schema} annotation can also be used standalone on the parameter or type.<a name="line.240"></a>
<span class="sourceLineNo">241</span> * Values specified on this field override values specified on the type, and values specified on child types override values<a name="line.241"></a>
<span class="sourceLineNo">242</span> * specified on parent types.<a name="line.242"></a>
<span class="sourceLineNo">243</span> *<a name="line.243"></a>
<span class="sourceLineNo">244</span> * &lt;h5 class='section'&gt;Used for:&lt;/h5&gt;<a name="line.244"></a>
<span class="sourceLineNo">245</span> * &lt;ul class='spaced-list'&gt;<a name="line.245"></a>
<span class="sourceLineNo">246</span> * &lt;li&gt;<a name="line.246"></a>
<span class="sourceLineNo">247</span> * Server-side schema-based parsing and parsing validation.<a name="line.247"></a>
<span class="sourceLineNo">248</span> * &lt;li&gt;<a name="line.248"></a>
<span class="sourceLineNo">249</span> * Server-side generated Swagger documentation.<a name="line.249"></a>
<span class="sourceLineNo">250</span> * &lt;li&gt;<a name="line.250"></a>
<span class="sourceLineNo">251</span> * Client-side schema-based serializing and serializing validation.<a name="line.251"></a>
<span class="sourceLineNo">252</span> * &lt;/ul&gt;<a name="line.252"></a>
<span class="sourceLineNo">253</span> *<a name="line.253"></a>
<span class="sourceLineNo">254</span> * @return The annotation value.<a name="line.254"></a>
<span class="sourceLineNo">255</span> */<a name="line.255"></a>
<span class="sourceLineNo">256</span> Schema schema() default @Schema;<a name="line.256"></a>
<span class="sourceLineNo">257</span><a name="line.257"></a>
<span class="sourceLineNo">258</span> /**<a name="line.258"></a>
<span class="sourceLineNo">259</span> * Specifies the {@link HttpPartSerializer} class used for serializing values to strings.<a name="line.259"></a>
<span class="sourceLineNo">260</span> *<a name="line.260"></a>
<span class="sourceLineNo">261</span> * &lt;p&gt;<a name="line.261"></a>
<span class="sourceLineNo">262</span> * Overrides for this part the part serializer defined on the REST client which by default is {@link OpenApiSerializer}.<a name="line.262"></a>
<span class="sourceLineNo">263</span> *<a name="line.263"></a>
<span class="sourceLineNo">264</span> * @return The annotation value.<a name="line.264"></a>
<span class="sourceLineNo">265</span> */<a name="line.265"></a>
<span class="sourceLineNo">266</span> Class&lt;? extends HttpPartSerializer&gt; serializer() default HttpPartSerializer.Void.class;<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span> /**<a name="line.268"></a>
<span class="sourceLineNo">269</span> * A synonym for {@link #name()}.<a name="line.269"></a>
<span class="sourceLineNo">270</span> *<a name="line.270"></a>
<span class="sourceLineNo">271</span> * &lt;p&gt;<a name="line.271"></a>
<span class="sourceLineNo">272</span> * Allows you to use shortened notation if you're only specifying the name.<a name="line.272"></a>
<span class="sourceLineNo">273</span> *<a name="line.273"></a>
<span class="sourceLineNo">274</span> * &lt;p&gt;<a name="line.274"></a>
<span class="sourceLineNo">275</span> * The following are completely equivalent ways of defining a form post entry:<a name="line.275"></a>
<span class="sourceLineNo">276</span> * &lt;p class='bjava'&gt;<a name="line.276"></a>
<span class="sourceLineNo">277</span> * &lt;jk&gt;public&lt;/jk&gt; Order placeOrder(&lt;ja&gt;@FormData&lt;/ja&gt;(name=&lt;js&gt;"petId"&lt;/js&gt;) &lt;jk&gt;long&lt;/jk&gt; &lt;jv&gt;petId&lt;/jv&gt;) {...}<a name="line.277"></a>
<span class="sourceLineNo">278</span> * &lt;/p&gt;<a name="line.278"></a>
<span class="sourceLineNo">279</span> * &lt;p class='bjava'&gt;<a name="line.279"></a>
<span class="sourceLineNo">280</span> * &lt;jk&gt;public&lt;/jk&gt; Order placeOrder(&lt;ja&gt;@FormData&lt;/ja&gt;(&lt;js&gt;"petId"&lt;/js&gt;) &lt;jk&gt;long&lt;/jk&gt; &lt;jv&gt;petId&lt;/jv&gt;) {...}<a name="line.280"></a>
<span class="sourceLineNo">281</span> * &lt;/p&gt;<a name="line.281"></a>
<span class="sourceLineNo">282</span> *<a name="line.282"></a>
<span class="sourceLineNo">283</span> * @return The annotation value.<a name="line.283"></a>
<span class="sourceLineNo">284</span> */<a name="line.284"></a>
<span class="sourceLineNo">285</span> String value() default "";<a name="line.285"></a>
<span class="sourceLineNo">286</span>}<a name="line.286"></a>
</pre>
</div>
</body>
</html>