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.i18n;
020
021import static java.lang.annotation.ElementType.FIELD;
022import static java.lang.annotation.RetentionPolicy.SOURCE;
023import static org.apiguardian.api.API.Status.STABLE;
024
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 annotation is used to mark a String constant that holds
033 *  the message prefix for the generated messages.} When the annotation
034 *  processor finds more than one field with this annotation, the result is
035 *  unpredictable.</p>
036 *  <p>If this annotation is not used, the constant
037 *  {@value org.tquadrat.foundation.i18n.I18nUtil#DEFAULT_MESSAGE_PREFIX}
038 *  will be used instead.</p>
039 *
040 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
041 *  @version $Id: MessagePrefix.java 882 2021-02-27 19:01:25Z tquadrat $
042 *  @since 0.1.0
043 */
044@Retention( SOURCE )
045@Target( FIELD )
046@ClassVersion( sourceVersion = "$Id: MessagePrefix.java 882 2021-02-27 19:01:25Z tquadrat $" )
047@API( status = STABLE, since = "0.1.0" )
048public @interface MessagePrefix
049{ /* Empty */ }
050//  class MessagePrefix
051
052/*
053 *  End of File
054 */