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   // UrlEncodingSerializer
038   //-------------------------------------------------------------------------------------------------------------------
039
040   /**
041    * Configuration property:  Parser bean property collections/arrays as separate key/value pairs.
042    *
043    * <p>
044    * This is the parser-side equivalent of the {@link UrlEncodingSerializer#URLENC_expandedParams} setting.
045    *
046    * <p>
047    * If <js>"false"</js>, serializing the array <c>[1,2,3]</c> results in <c>?key=$a(1,2,3)</c>.
048    * <br>If <js>"true"</js>, serializing the same array results in <c>?key=1&amp;key=2&amp;key=3</c>.
049    *
050    * <ul class='notes'>
051    *    <li>
052    *       Possible values:
053    *       <ul>
054    *          <li><js>"true"</js>
055    *          <li><js>"false"</js> (default)
056    *       </ul>
057    *    <li>
058    *       If parsing multi-part parameters, it's highly recommended to use Collections or Lists
059    *       as bean property types instead of arrays since arrays have to be recreated from scratch every time a value
060    *       is added to it.
061    *    <li>
062    *       This option only applies to beans.
063    *    <li>
064    *       Supports {@doc DefaultSvlVariables} (e.g. <js>"$C{myConfigVar}"</js>).
065    *    <li>
066    *       A default global value can be set via the system property <js>"UrlEncodingSerializer.expandedParams.b"</js>.
067    * </ul>
068    *
069    * <ul class='seealso'>
070    *    <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}
071    * </ul>
072    */
073   String expandedParams() default "";
074}