| <!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.urlencoding.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.urlencoding.*;<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> * Annotation for specifying config properties defined in {@link UrlEncodingSerializer} and {@link UrlEncodingParser}.<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> *<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <p><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Used primarily for specifying bean configuration properties on REST classes and methods.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> */<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>@Documented<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>@Target({TYPE,METHOD})<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>@Retention(RUNTIME)<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>@Inherited<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>@PropertyStoreApply(UrlEncodingConfigApply.class)<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>public @interface UrlEncodingConfig {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Optional rank for this config.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Can be used to override default ordering and application of config annotations.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> int rank() default 0;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> // UrlEncodingCommon<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> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Dynamically applies {@link UrlEncoding @UrlEncoding} annotations to specified classes/methods/fields.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Provides an alternate approach for applying annotations using {@link UrlEncoding#on() @UrlEncoding.on} to specify the names<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * to apply the annotation to.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <ul class='seealso'><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <li class='link'>{@doc DynamicallyAppliedAnnotations}<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </ul><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> UrlEncoding[] applyUrlEncoding() default {};<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> // UrlEncodingSerializer<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Configuration property: Parser bean property collections/arrays as separate key/value pairs.<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> * This is the parser-side equivalent of the {@link UrlEncodingSerializer#URLENC_expandedParams} setting.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> *<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <p><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * If <js>"false"</js>, serializing the array <c>[1,2,3]</c> results in <c>?key=$a(1,2,3)</c>.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <br>If <js>"true"</js>, serializing the same array results in <c>?key=1&amp;key=2&amp;key=3</c>.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> *<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <ul class='notes'><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <li><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Possible values:<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <ul><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <li><js>"true"</js><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <li><js>"false"</js> (default)<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * </ul><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <li><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * If parsing multi-part parameters, it's highly recommended to use Collections or Lists<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * as bean property types instead of arrays since arrays have to be recreated from scratch every time a value<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * is added to it.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <li><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * This option only applies to beans.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <li><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Supports {@doc DefaultVarResolver} (e.g. <js>"$C{myConfigVar}"</js>).<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * </ul><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * <ul class='seealso'><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * </ul><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> String expandedParams() default "";<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> // UrlEncodingParser<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.100"></a> |
| <span class="sourceLineNo">101</span>}<a name="line.101"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
