001/*
002 * ============================================================================
003 *  Copyright © 2002-2024 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;
024import static org.tquadrat.foundation.i18n.TextUse.TEXTUSE_DEFAULT;
025
026import java.lang.annotation.Repeatable;
027import java.lang.annotation.Retention;
028import java.lang.annotation.Target;
029
030import org.apiguardian.api.API;
031import org.tquadrat.foundation.annotation.ClassVersion;
032
033/**
034 *  <p>{@summary Marker for omitted texts.}</p>
035 *  <p>Use it to annotate elements that are expected to have a certain text
036 *  associated with, but this is not there – either because it was omitted
037 *  completely, or because it is defined elsewhere.</p>
038 *  <p>This annotation is more or less a formalised comment, it will not be
039 *  processed in any way.</p>
040 *
041 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
042 *  @version $Id: NoText.java 1124 2024-03-19 11:02:47Z tquadrat $
043 *  @since 0.4.6
044 *
045 *  @UMLGraph.link
046 */
047@Retention( SOURCE )
048@Target( {FIELD, METHOD} )
049@Repeatable( NoTexts.class )
050@ClassVersion( sourceVersion = "$Id: NoText.java 1124 2024-03-19 11:02:47Z tquadrat $" )
051@API( status = STABLE, since = "0.4.6" )
052public @interface NoText
053{
054        /*------------*\
055    ====** Attributes **=======================================================
056        \*------------*/
057    /**
058     *  <p>{@summary The expected use of the omitted text; the default is
059     *  {@link TextUse#TEXTUSE_DEFAULT}.}</p>
060     *
061     *  @return The text use.
062     */
063    TextUse use() default TEXTUSE_DEFAULT;
064
065    /**
066     *  Returns the explanation why the text was omitted here.
067     *
068     *  @return The description.
069     */
070    String explanation() default "";
071}
072//  @interface NoText
073
074/*
075 *  End of File
076 */