org.hipparchus.genetics

Enum LocalizedGeneticsFormats

java.lang.Object

java.lang.Enum<LocalizedGeneticsFormats>

org.hipparchus.genetics.LocalizedGeneticsFormats

All Implemented Interfaces:

Serializable, Comparable<LocalizedGeneticsFormats>, Localizable

public enum LocalizedGeneticsFormats
extends Enum<LocalizedGeneticsFormats>
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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CROSSOVER_RATE
DIFFERENT_ORIG_AND_PERMUTED_DATA
ELITISM_RATE
INVALID_BINARY_CHROMOSOME
INVALID_BINARY_DIGIT
INVALID_FIXED_LENGTH_CHROMOSOME
LIST_OF_CHROMOSOMES_BIGGER_THAN_POPULATION_SIZE
MUTATION_RATE
POPULATION_LIMIT_NOT_POSITIVE
RANDOMKEY_MUTATION_WRONG_CLASS
TOO_LARGE_TOURNAMENT_ARITY

Method Summary

Modifier and Type	Method and Description
String	getLocalizedString(Locale locale) Gets the localized string.
String	getSourceString() Gets the source (non-localized) string.
static LocalizedGeneticsFormats	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocalizedGeneticsFormats[]	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

CROSSOVER_RATE

public static final LocalizedGeneticsFormats CROSSOVER_RATE

DIFFERENT_ORIG_AND_PERMUTED_DATA

public static final LocalizedGeneticsFormats DIFFERENT_ORIG_AND_PERMUTED_DATA

ELITISM_RATE

public static final LocalizedGeneticsFormats ELITISM_RATE

INVALID_BINARY_CHROMOSOME

public static final LocalizedGeneticsFormats INVALID_BINARY_CHROMOSOME

INVALID_FIXED_LENGTH_CHROMOSOME

public static final LocalizedGeneticsFormats INVALID_FIXED_LENGTH_CHROMOSOME

INVALID_BINARY_DIGIT

public static final LocalizedGeneticsFormats INVALID_BINARY_DIGIT

LIST_OF_CHROMOSOMES_BIGGER_THAN_POPULATION_SIZE

public static final LocalizedGeneticsFormats LIST_OF_CHROMOSOMES_BIGGER_THAN_POPULATION_SIZE

MUTATION_RATE

public static final LocalizedGeneticsFormats MUTATION_RATE

POPULATION_LIMIT_NOT_POSITIVE

public static final LocalizedGeneticsFormats POPULATION_LIMIT_NOT_POSITIVE

RANDOMKEY_MUTATION_WRONG_CLASS

public static final LocalizedGeneticsFormats RANDOMKEY_MUTATION_WRONG_CLASS

TOO_LARGE_TOURNAMENT_ARITY

public static final LocalizedGeneticsFormats TOO_LARGE_TOURNAMENT_ARITY

Method Detail

values

public static LocalizedGeneticsFormats[] 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 (LocalizedGeneticsFormats c : LocalizedGeneticsFormats.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LocalizedGeneticsFormats 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.