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