001/*
002 * ============================================================================
003 *  Copyright © 2002-2021 by Thomas Thrien.
004 *  All Rights Reserved.
005 * ============================================================================
006 *  Licensed to the public under the agreements of the GNU Lesser General Public
007 *  License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *       http://www.gnu.org/licenses/lgpl.html
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, WITHOUT
013 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 *  License for the specific language governing permissions and limitations
015 *  under the License.
016 */
017
018package org.tquadrat.foundation.annotation;
019
020import static java.lang.annotation.ElementType.METHOD;
021import static java.lang.annotation.RetentionPolicy.CLASS;
022import static org.apiguardian.api.API.Status.STABLE;
023
024import java.lang.annotation.Documented;
025import java.lang.annotation.Retention;
026import java.lang.annotation.Target;
027
028import org.apiguardian.api.API;
029
030/**
031 *  <p>{@summary Associates a property name to a method.}</p>
032 *  <p>For a JavaBean, the name of the respective property is usually derived
033 *  from the name of the method; so for the method {@code getValue()}, the
034 *  name of the property is &quot;{@code value}&quot;, and for
035 *  {@code setString()}, it would be &quot;{@code string}&quot;.</p>
036 *  <p>But sometimes this is not wanted or not possible.</p>
037 *  <p>In these cases, the accessor and/or mutator methods for that property
038 *  can be annotated with this annotation to get an arbitrary name.</p>
039 *
040 *  @note   The annotation is used by several annotation processors, but this
041 *      module itself does not provide any means to interpret or validate this
042 *      annotation.
043 *
044 *  @note The value has to be a valid Java identifier.
045 *
046 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
047 *  @version $Id: PropertyName.java 885 2021-03-23 19:33:53Z tquadrat $
048 *  @since 0.1.0
049 */
050@ClassVersion( sourceVersion = "$Id: PropertyName.java 885 2021-03-23 19:33:53Z tquadrat $" )
051@Documented
052@Retention( CLASS )
053@Target( METHOD )
054@API( status = STABLE, since = "0.1.0" )
055public @interface PropertyName
056{
057        /*------------*\
058    ====** Attributes **=======================================================
059        \*------------*/
060    /**
061     *  The name for the property.
062     *
063     *  @note The value has to be a valid Java identifier.
064     *
065     *  @return The name for the property.
066     */
067    String value();
068}
069//  annotation PropertyName
070
071/*
072 *  End of File
073 */