| // *************************************************************************************************************************** | |
| // * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file * | |
| // * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file * | |
| // * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance * | |
| // * with the License. You may obtain a copy of the License at * | |
| // * * | |
| // * http://www.apache.org/licenses/LICENSE-2.0 * | |
| // * * | |
| // * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an * | |
| // * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * | |
| // * specific language governing permissions and limitations under the License. * | |
| // *************************************************************************************************************************** | |
| package org.apache.juneau.annotation; | |
| import static java.lang.annotation.ElementType.*; | |
| import static java.lang.annotation.RetentionPolicy.*; | |
| import java.lang.annotation.*; | |
| /** | |
| * Identifies a setter as a method for setting the name of a POJO as it's known by its parent object. | |
| * | |
| * <ul class='notes'> | |
| * <li> | |
| * The annotated field or method does not need to be public. | |
| * </ul> | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.Transforms.NamePropertyAnnotation} | |
| * </ul> | |
| */ | |
| @Target({METHOD,FIELD}) | |
| @Retention(RUNTIME) | |
| @Inherited | |
| public @interface NameProperty { | |
| /** | |
| * Dynamically apply this annotation to the specified methods/fields. | |
| * | |
| * <p> | |
| * Used in conjunction with the {@link BeanConfig#applyNameProperty()}. | |
| * It is ignored when the annotation is applied directly to methods/fields. | |
| * | |
| * <p> | |
| * The valid pattern matches are: | |
| * <ul> | |
| * <li>Methods: | |
| * <ul> | |
| * <li>Fully qualified with args: <js>"com.foo.MyClass.myMethod(String,int)"</js> or <js>"com.foo.MyClass.myMethod(java.lang.String,int)"</js> or <js>"com.foo.MyClass.myMethod()"</js> | |
| * <li>Fully qualified: <js>"com.foo.MyClass.myMethod"</js> | |
| * <li>Simple with args: <js>"MyClass.myMethod(String,int)"</js> or <js>"MyClass.myMethod(java.lang.String,int)"</js> or <js>"MyClass.myMethod()"</js> | |
| * <li>Simple: <js>"MyClass.myMethod"</js> | |
| * <li>Simple inner class: <js>"MyClass$Inner1$Inner2.myMethod"</js> or <js>"Inner1$Inner2.myMethod"</js> or <js>"Inner2.myMethod"</js> | |
| * </ul> | |
| * <li>Fields: | |
| * <ul> | |
| * <li>Fully qualified: <js>"com.foo.MyClass.myField"</js> | |
| * <li>Simple: <js>"MyClass.muyField"</js> | |
| * <li>Simple inner class: <js>"MyClass$Inner1$Inner2.myField"</js> or <js>"Inner1$Inner2.myField"</js> or <js>"Inner2.myField"</js> | |
| * </ul> | |
| * <li>A comma-delimited list of anything on this list. | |
| * </ul> | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.DynamicallyAppliedAnnotations} | |
| * </ul> | |
| */ | |
| String on() default ""; | |
| } |