Enum Class TextUse

java.lang.Object
java.lang.Enum<TextUse>
org.tquadrat.foundation.i18n.TextUse
All Implemented Interfaces:
Serializable, Comparable<TextUse>, Constable
@ClassVersion(sourceVersion="$Id: TextUse.java 1123 2024-03-19 10:06:45Z tquadrat $") @API(status=STABLE, since="0.1.0") public enum TextUse extends Enum<TextUse>
The uses for a text. It is used to compose the resource bundle key for text.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: TextUse.java 1123 2024-03-19 10:06:45Z tquadrat $
Since:
0.1.0
See Also:
UML Diagram
UML Diagram for "org.tquadrat.foundation.i18n.TextUse"⁠

UML Diagram for "org.tquadrat.foundation.i18n.TextUse"

UML Diagram for "org.tquadrat.foundation.i18n.TextUse"⁠

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BUTTON
    The text for a button.
    CAPTION
    A caption for a GUI form.
    FILE
    The localised name of a file.
    FOLDER
    The localised name of a folder/directory.
    HEADER
    A column header or alike.
    HELP
    A help text.
    LINK
    A localised link or part of a link.
    MENU
    The name of a menu entry.
    MESSAGE
    A message, although these are usually messages, defined with @Message, and not texts that will be defined with @Text.
    NAME
    The localised name of a property.
    PROMPT
    A prompt text.
    SECTION
    A section header or alike.
    STRING
    The String representation for an enum value.
    TEXTUSE_DEFAULT
    The default; should not be used.
    TITLE
    A title text (a window title, or a program title, or alike).
    TOOLTIP
    A tooltip text.
    TXT
    A general purpose text.
    USAGE
    The text is a usage message for an argument or an option on the command line.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    TextUse()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static TextUse
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TextUse[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Constructor Details

  • Method Details

    • values

      public static TextUse[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TextUse valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null