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.annotation;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024/**
025 * Annotation that can be used on method parameters to identify their name.
026 *
027 * <p>
028 * Can be used in the following locations:
029 * <ul>
030 *    <li>On constructor and method arguments when the parameter names are not in the compiled bytecode.
031 * </ul>
032 *
033 * <h5 class='figure'>Examples:</h5>
034 * <p class='bjava'>
035 *    <jc>// Identifying bean property names.
036 *    // The field name can be anything.</jc>
037 *    <jk>public class</jk> MyBean {
038 *
039 *       <jk>public</jk> MyBean(<ja>@Name</ja>(<js>"bar"</js>) <jk>int</jk> <jv>foo</jv>) {}
040 *    }
041 * </p>
042 *
043 * <h5 class='section'>See Also:</h5><ul>
044
045 * </ul>
046 */
047@Documented
048@Target({PARAMETER})
049@Retention(RUNTIME)
050@Inherited
051public @interface Name {
052
053   /**
054    * The bean property or parameter name.
055    *
056    * @return The annotation value.
057    */
058   String value();
059}