Package org.hipparchus.stat

Enum LocalizedStatFormats

java.lang.Object

java.lang.Enum<LocalizedStatFormats>

org.hipparchus.stat.LocalizedStatFormats

All Implemented Interfaces:

Serializable, Comparable<LocalizedStatFormats>, Localizable

public enum LocalizedStatFormats
extends Enum<LocalizedStatFormats>
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	Description
COVARIANCE_MATRIX
INSUFFICIENT_DATA_FOR_T_STATISTIC
INVALID_REGRESSION_OBSERVATION
NO_REGRESSORS
NOT_ENOUGH_DATA_FOR_NUMBER_OF_PREDICTORS
NOT_ENOUGH_DATA_REGRESSION
NOT_SUPPORTED_NAN_STRATEGY
OUT_OF_BOUND_SIGNIFICANCE_LEVEL
OUT_OF_BOUNDS_CONFIDENCE_LEVEL
OUT_OF_BOUNDS_QUANTILE_VALUE
SIGNIFICANCE_LEVEL
TIES_ARE_NOT_ALLOWED
TOO_MANY_REGRESSORS
TWO_OR_MORE_CATEGORIES_REQUIRED
TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED

Method Summary

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

TIES_ARE_NOT_ALLOWED

public static final LocalizedStatFormats TIES_ARE_NOT_ALLOWED

INSUFFICIENT_DATA_FOR_T_STATISTIC

public static final LocalizedStatFormats INSUFFICIENT_DATA_FOR_T_STATISTIC

NOT_ENOUGH_DATA_REGRESSION

public static final LocalizedStatFormats NOT_ENOUGH_DATA_REGRESSION

INVALID_REGRESSION_OBSERVATION

public static final LocalizedStatFormats INVALID_REGRESSION_OBSERVATION

NOT_ENOUGH_DATA_FOR_NUMBER_OF_PREDICTORS

public static final LocalizedStatFormats NOT_ENOUGH_DATA_FOR_NUMBER_OF_PREDICTORS

NOT_SUPPORTED_NAN_STRATEGY

public static final LocalizedStatFormats NOT_SUPPORTED_NAN_STRATEGY

NO_REGRESSORS

public static final LocalizedStatFormats NO_REGRESSORS

COVARIANCE_MATRIX

public static final LocalizedStatFormats COVARIANCE_MATRIX

OUT_OF_BOUNDS_QUANTILE_VALUE

public static final LocalizedStatFormats OUT_OF_BOUNDS_QUANTILE_VALUE

OUT_OF_BOUNDS_CONFIDENCE_LEVEL

public static final LocalizedStatFormats OUT_OF_BOUNDS_CONFIDENCE_LEVEL

OUT_OF_BOUND_SIGNIFICANCE_LEVEL

public static final LocalizedStatFormats OUT_OF_BOUND_SIGNIFICANCE_LEVEL

SIGNIFICANCE_LEVEL

public static final LocalizedStatFormats SIGNIFICANCE_LEVEL

TOO_MANY_REGRESSORS

public static final LocalizedStatFormats TOO_MANY_REGRESSORS

TWO_OR_MORE_CATEGORIES_REQUIRED

public static final LocalizedStatFormats TWO_OR_MORE_CATEGORIES_REQUIRED

TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED

public static final LocalizedStatFormats TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED

Method Detail

values

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

Returns:

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

valueOf

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