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.i18n;
019
020import static java.lang.annotation.ElementType.FIELD;
021import static java.lang.annotation.ElementType.METHOD;
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 Use this annotation to define a text for a message or a UI
033 *  element that has to be translated.} The build process will take care of
034 *  this definition and creates the required resource bundle properties
035 *  files.</p>
036 *  <p>This annotation can only be used in conjunction with the annotations
037 *  {@link Text &#64;Text}
038 *  and
039 *  {@link Message &#64;Message}.</p>
040 *
041 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
042 *  @version $Id: Translation.java 882 2021-02-27 19:01:25Z tquadrat $
043 *  @since 0.0.2
044 */
045@Retention( SOURCE )
046@Target( {FIELD, METHOD} )
047@ClassVersion( sourceVersion = "$Id: Translation.java 882 2021-02-27 19:01:25Z tquadrat $" )
048@API( status = STABLE, since = "0.0.2" )
049public @interface Translation
050{
051        /*------------*\
052    ====** Attributes **=======================================================
053        \*------------*/
054    /**
055     *  Returns the name of the language for this translation. At least, this
056     *  has to be the ISO language code, but it can be extended to a full
057     *  locale id with country code and extensions, if desired.
058     *
059     *  @see java.util.Locale
060     *
061     *  @return The locale.
062     */
063    String language();
064
065    /**
066     *  Returns the text itself.
067     *
068     *  @return The translated text for the language defined by the locale.
069     */
070    String text();
071}
072//  annotation Translation
073
074/*
075 *  End of File
076 */