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.TYPE;
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.Repeatable;
026import java.lang.annotation.Retention;
027import java.lang.annotation.Target;
028
029import org.apiguardian.api.API;
030import org.tquadrat.foundation.annotation.ClassVersion;
031
032/**
033 *  The definition for a {@code INI} file group.
034 *
035 *  @version $Id: INIGroup.java 949 2021-12-28 11:09:25Z tquadrat $
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @since 0.1.0
038 */
039@ClassVersion( sourceVersion = "$Id: INIGroup.java 949 2021-12-28 11:09:25Z tquadrat $" )
040@Documented
041@Retention( CLASS )
042@Target( TYPE )
043@Repeatable( INIGroups.class )
044@API( status = STABLE, since = "0.1.0" )
045public @interface INIGroup
046{
047        /*------------*\
048    ====** Attributes **=======================================================
049        \*------------*/
050    /**
051     *  The comment for the group.
052     *
053     *  @return The comment.
054     */
055    public String comment() default "";
056
057    /**
058     *  The name for the group.
059     *
060     *  @return The name for the group.
061     */
062    public String name();
063}
064//  @interface INIGroup
065
066/*
067 *  End of File
068 */