001/*
002 * ============================================================================
003 * Copyright © 2002-2021 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.config;
020
021import static java.lang.annotation.ElementType.METHOD;
022import static java.lang.annotation.RetentionPolicy.CLASS;
023import static org.apiguardian.api.API.Status.STABLE;
024
025import java.lang.annotation.Documented;
026import java.lang.annotation.Retention;
027import java.lang.annotation.Target;
028
029import org.apiguardian.api.API;
030import org.tquadrat.foundation.annotation.ClassVersion;
031import org.tquadrat.foundation.config.spi.prefs.PreferenceAccessor;
032
033/**
034 *  {@summary Forces a property to have a preferences reference and configures
035 *  it.} Usually, all attributes of a property that are required for the
036 *  preferences will be inferred from the property itself. This annotation
037 *  allows to modify these default values.
038 *
039 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
040 *  @version $Id: Preference.java 941 2021-12-18 22:34:37Z tquadrat $
041 *  @since 0.0.1
042 */
043@ClassVersion( sourceVersion = "$Id: Preference.java 941 2021-12-18 22:34:37Z tquadrat $" )
044@Documented
045@Retention( CLASS )
046@Target( METHOD )
047@API( status = STABLE, since = "0.0.1" )
048public @interface Preference
049{
050        /*------------*\
051    ====** Attributes **=======================================================
052        \*------------*/
053    /**
054     *  <p>{@summary The accessor that is used to set the property from the
055     *  preference, and the preference from the property value. For most types,
056     *  this can be derived from the type, but for others, it needs to be set
057     *  explicitly.}</p>
058     *  <p>The value
059     *  {@link PreferenceAccessor PreferenceAccessor.class}
060     *  indicates the default setting.</p>
061     *
062     *  @return The class for the accessor.
063     *
064     *  @see PreferenceAccessor
065     */
066    Class<?> accessor() default PreferenceAccessor.class;
067
068    /**
069     *  The key for the preference; the default is the property name.
070     *
071     *  @return The key.
072     */
073    String key() default "";
074}
075//  class Preference
076
077/*
078 *  End of File
079 */