Package com.iizix.text

Interface IEnumLocaleString

All Known Subinterfaces:
IEnumLocaleKString, IPropReference.IRefType
All Known Implementing Classes:
IPropReference.RefType, IServer.InvalidAppID, LocaleString, Messages, References.ReturnCode, SigninResult, UserLocaleString
public interface IEnumLocaleString
Interface used by enum's to retrieve the "id" and the "fallback" strings when formatting values to locale String's.
Author:
Christopher Mindus

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    asString()
    Gets the plain string for an enum value.
    default String
    asString(SessionInfo sessionInfo)
    Gets the plain string for an enum value.
    default String
    asString(ILocaleString localeString)
    Gets the plain string for an enum value.
    String
    getFallback()
    Gets the fallback String.
    String
    getID()
    Gets the text ID.
    String
    name()
    Returns the name of this enum constant, exactly as declared in its enum declaration.
    int
    ordinal()
    Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
    default List<IEnumLocaleString>
    valuesList()
    Default implementation to return all possible values in the enum.

  • Method Details

    • valuesList

      default List<IEnumLocaleString> valuesList()
      Default implementation to return all possible values in the enum.
      Returns:
      An unmodifiable list of the elements in the enum.

    • name

      String name()
      Returns the name of this enum constant, exactly as declared in its enum declaration.
      Returns:
      The name() as called for in an enum class.

    • ordinal

      int ordinal()
      Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
      Returns:
      The ordinal of the enum item.

    • getID

      String getID()
      Gets the text ID.
      Returns:
      The text ID string.

    • getFallback

      String getFallback()
      Gets the fallback String.
      Returns:
      The fallback string.

    • asString

      default String asString()
      Gets the plain string for an enum value. The string will be in the client session's language setting, the application session's setting or the default language setting and if none of these were found in the specified order, the getFallback() string is returned.
      Returns:
      The String for the enum in most accurate locale.

    • asString

      default String asString(SessionInfo sessionInfo)
      Gets the plain string for an enum value. The string will be in the client session's language setting, the application session's setting or the default language setting and if none of these were found in the specified order, the getFallback() string is returned.
      Parameters:
      sessionInfo - The session information, or null if not available. if null the system will attempt to look up the current client or application session from the current thread.
      Returns:
      The String for the enum in most accurate locale.

    • asString

      default String asString(ILocaleString localeString)
      Gets the plain string for an enum value. The string will be in the client session's language setting, the application session's setting or the default language setting and if none of these were found in the specified order, the getFallback() string is returned.
      Parameters:
      localeString - The localeString instance to used for localization, or null for fallback return value if text ID is not found.
      Returns:
      The String for the enum in most accurate locale.