001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.urlencoding.annotation;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020import org.apache.juneau.annotation.*;
021import org.apache.juneau.urlencoding.*;
022
023/**
024 * Annotation for specifying config properties defined in {@link UrlEncodingSerializer} and {@link UrlEncodingParser}.
025 *
026 * <p>
027 * Used primarily for specifying bean configuration properties on REST classes and methods.
028 */
029@Documented
030@Target({TYPE,METHOD})
031@Retention(RUNTIME)
032@Inherited
033@PropertyStoreApply(UrlEncodingConfigApply.class)
034public @interface UrlEncodingConfig {
035
036   /**
037    * Optional rank for this config.
038    *
039    * <p>
040    * Can be used to override default ordering and application of config annotations.
041    */
042   int rank() default 0;
043
044   //-------------------------------------------------------------------------------------------------------------------
045   // UrlEncodingCommon
046   //-------------------------------------------------------------------------------------------------------------------
047
048   /**
049    * Dynamically applies {@link UrlEncoding @UrlEncoding} annotations to specified classes/methods/fields.
050    *
051    * <p>
052    * Provides an alternate approach for applying annotations using {@link UrlEncoding#on() @UrlEncoding.on} to specify the names
053    * to apply the annotation to.
054    *
055    * <ul class='seealso'>
056    *    <li class='link'>{@doc DynamicallyAppliedAnnotations}
057    * </ul>
058    */
059   UrlEncoding[] applyUrlEncoding() default {};
060
061   //-------------------------------------------------------------------------------------------------------------------
062   // UrlEncodingSerializer
063   //-------------------------------------------------------------------------------------------------------------------
064
065   /**
066    * Configuration property:  Parser bean property collections/arrays as separate key/value pairs.
067    *
068    * <p>
069    * This is the parser-side equivalent of the {@link UrlEncodingSerializer#URLENC_expandedParams} setting.
070    *
071    * <p>
072    * If <js>"false"</js>, serializing the array <c>[1,2,3]</c> results in <c>?key=$a(1,2,3)</c>.
073    * <br>If <js>"true"</js>, serializing the same array results in <c>?key=1&amp;key=2&amp;key=3</c>.
074    *
075    * <ul class='notes'>
076    *    <li>
077    *       Possible values:
078    *       <ul>
079    *          <li><js>"true"</js>
080    *          <li><js>"false"</js> (default)
081    *       </ul>
082    *    <li>
083    *       If parsing multi-part parameters, it's highly recommended to use Collections or Lists
084    *       as bean property types instead of arrays since arrays have to be recreated from scratch every time a value
085    *       is added to it.
086    *    <li>
087    *       This option only applies to beans.
088    *    <li>
089    *       Supports {@doc DefaultVarResolver} (e.g. <js>"$C{myConfigVar}"</js>).
090    * </ul>
091    *
092    * <ul class='seealso'>
093    *    <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}
094    * </ul>
095    */
096   String expandedParams() default "";
097
098   //-------------------------------------------------------------------------------------------------------------------
099   // UrlEncodingParser
100   //-------------------------------------------------------------------------------------------------------------------
101}