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.annotation;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020/**
021 * Annotation that can be used on method parameters to identify their name.
022 *
023 * <p>
024 * Can be used in the following locations:
025 * <ul>
026 *    <li>In place of <code><ja>@BeanProperty</ja>(name=<js>"foo"</js>)</code> when just the name is specified.
027 *    <li>On constructor and method arguments when the parameter names are not in the compiled bytecode.
028 * </ul>
029 *
030 * <h5 class='figure'>Examples:</h5>
031 * <p class='bcode w800'>
032 *    <jc>// Identifying bean property names.
033 *    // The field name can be anything.</jc>
034 *    <jk>public class</jk> MyBean {
035 *
036 *       <jc>// Same as @BeanProperty(properties="bar")</jc>
037 *       <jk>public</jk> MyBean(@Name("bar") <jk>int</jk> foo) {}
038 *
039 *       <ja>@Name</ja>(<js>"bar"</js>) <jc>// Same as @BeanProperty(name="bar")</jc>
040 *       <jk>public int</jk> foo;
041 *
042 *       <ja>@Name</ja>(<js>"*"</js>) <jc>// Same as @BeanProperty(name="*")</jc>
043 *       <jk>public</jk> Map&lt;String,Object&gt; extraStuff = <jk>new</jk> LinkedHashMap&lt;String,Object&gt;();
044 *    }
045 * </p>
046 */
047@Documented
048@Target({PARAMETER,METHOD,FIELD})
049@Retention(RUNTIME)
050@Inherited
051public @interface Name {
052
053   /**
054    * The bean property or parameter name.
055    */
056   String value();
057}