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.config;
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;
029import org.tquadrat.foundation.annotation.ClassVersion;
030
031/**
032 *  <p>{@summary The marker for properties that will be persisted in an
033 *  {@code INI} file.}</p>
034 *  <p>This annotation implies the
035 *  {@link NoPreference &#64;NoPreference}
036 *  annotation.</p>
037 *  <p>Any type of a property can be persisted to an {@code INI} file as long
038 *  as a proper implementation of
039 *  {@link org.tquadrat.foundation.lang.StringConverter}
040 *  can be provided for that type.</p>
041 *
042 *  @version $Id: INIValue.java 946 2021-12-23 14:48:19Z tquadrat $
043 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
044 *  @since 0.1.0
045 *
046 *  @see StringConversion &#64;StringConversion
047 */
048@ClassVersion( sourceVersion = "$Id: INIValue.java 946 2021-12-23 14:48:19Z tquadrat $" )
049@Documented
050@Retention( CLASS )
051@Target( METHOD )
052@API( status = STABLE, since = "0.1.0" )
053public @interface INIValue
054{
055        /*------------*\
056    ====** Attributes **=======================================================
057        \*------------*/
058    /**
059     *  The comment for the value.
060     *
061     *  @return The comment.
062     */
063    public String comment() default "";
064
065    /**
066     *  The mandatory group for the value in the configuration file.
067     *
068     *  @return The group.
069     */
070    public String group();
071
072    /**
073     *  The key for the value in the configuration file. If not provided, the
074     *  property name is used instead.
075     *
076     *  @return The key.
077     */
078    public String key() default "";
079}
080//  @interface INIValue
081
082/*
083 *  End of File
084 */