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.urlencoding.*;
021
022/**
023 * Annotation that can be applied to classes, fields, and methods to tweak how they are handled by
024 * {@link UrlEncodingSerializer} and {@link UrlEncodingParser}.
025 */
026@Documented
027@Target({TYPE})
028@Retention(RUNTIME)
029@Inherited
030public @interface UrlEncoding {
031
032   /**
033    * When true, bean properties of type array or Collection will be expanded into multiple key/value pairings.
034    *
035    * <p>
036    * This annotation is identical in behavior to using the {@link UrlEncodingSerializer#URLENC_expandedParams}
037    * and {@link UrlEncodingParser#URLENC_expandedParams} properties, but applies to only instances of this bean.
038    */
039   boolean expandedParams() default false;
040}