Package com.iizix.message

Enum IzRuntimeMessage

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<IzRuntimeMessage>
    public enum IzRuntimeMessage
extends java.lang.Enum<IzRuntimeMessage>
    The runtime messages coded by default in English. This class provides an "exit" to the current application being run and a check if that application provides the message in question, possibly localized. If is not handled, the iizi locales are checked for the current application user session.
    Author:
    Christopher Mindus

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.Stringget()
      Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.
      java.lang.Stringget​(LocaleInfo localeInfo)
      Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.
      java.lang.Stringget​(LocaleInfo localeInfo, java.lang.Object... parameters)
      Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.
      java.lang.Stringget​(java.lang.Object... parameters)
      Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.
      java.lang.StringgetEnglish()
      Gets the English message text.
      java.lang.StringgetEnlish​(java.lang.Object... parameters)
      Gets the English string formatted with parameters.
      static IzRuntimeMessagevalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static IzRuntimeMessage[]values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • GeneralValueConversionError_HTML

        public static final IzRuntimeMessage GeneralValueConversionError_HTML
        The message for an invalid value conversion in HTML: "[b]Input error[/b][br]exception".

      • GeneralValueConversionError_plain

        public static final IzRuntimeMessage GeneralValueConversionError_plain
        The message for an invalid value conversion in plain text: "Input error: exception".

    • Method Detail

      • values

        public static IzRuntimeMessage[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (IzRuntimeMessage c : IzRuntimeMessage.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static IzRuntimeMessage valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getEnglish

        public java.lang.String getEnglish()
        Gets the English message text.
        Returns:
        The English message text.

      • getEnlish

        public java.lang.String getEnlish​(java.lang.Object... parameters)
        Gets the English string formatted with parameters.

        The string is formatted with the parameters using MessageFormat.

        Parameters:
        parameters - The parameters.
        Returns:
        The English message text formatted with the parameters. If an error occurs during formatting, it is logged as a warning with all parameters.

      • get

        public java.lang.String get()
        Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.
        Returns:
        The localized message text.

      • get

        public java.lang.String get​(LocaleInfo localeInfo)
        Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.
        Returns:
        The localized message text.

      • get

        public java.lang.String get​(java.lang.Object... parameters)
        Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.

        The string is formatted with the parameters using MessageFormat.

        Parameters:
        parameters - The parameters.
        Returns:
        The localized message text formatted with the parameters. If an error occurs during formatting, it is logged as a warning with all parameters.

      • get

        public java.lang.String get​(LocaleInfo localeInfo,
                            java.lang.Object... parameters)
        Gets the localized string of the current user session (if any) from the current application (if any), or if not found, from the resource bundle in this package.

        The string is formatted with the parameters using MessageFormat.

        Parameters:
        parameters - The parameters.
        Returns:
        The localized message text formatted with the parameters. If an error occurs during formatting, it is logged as a warning with all parameters.