Package org.hipparchus.optim

Enum LocalizedOptimFormats

  • All Implemented Interfaces:
    Serializable, Comparable<LocalizedOptimFormats>, Localizable
    public enum LocalizedOptimFormats
extends Enum<LocalizedOptimFormats>
implements Localizable
    Enumeration for localized messages formats used in exceptions messages.

    The constants in this enumeration represent the available formats as localized strings. These formats are intended to be localized using simple properties files, using the constant name as the key and the property value as the message format. The source English format is provided in the constants themselves to serve both as a reminder for developers to understand the parameters needed by each format, as a basis for translators to create localized properties files, and as a default format if some translation is missing.

    • Method Detail

      • values

        public static LocalizedOptimFormats[] 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 (LocalizedOptimFormats c : LocalizedOptimFormats.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static LocalizedOptimFormats valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getSourceString

        public String getSourceString()
        Gets the source (non-localized) string.
        Specified by:
        getSourceString in interface Localizable
        Returns:
        the source string.

      • getLocalizedString

        public String getLocalizedString​(Locale locale)
        Gets the localized string.
        Specified by:
        getLocalizedString in interface Localizable
        Parameters:
        locale - locale into which to get the string.
        Returns:
        the localized string or the source string if no localized version is available.