org.hipparchus.transform

Enum LocalizedFFTFormats

java.lang.Object

java.lang.Enum<LocalizedFFTFormats>

org.hipparchus.transform.LocalizedFFTFormats

All Implemented Interfaces:

Serializable, Comparable<LocalizedFFTFormats>, Localizable

public enum LocalizedFFTFormats
extends Enum<LocalizedFFTFormats>
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
FIRST_ELEMENT_NOT_ZERO
NOT_POWER_OF_TWO
NOT_POWER_OF_TWO_CONSIDER_PADDING
NOT_POWER_OF_TWO_PLUS_ONE

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 LocalizedFFTFormats	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocalizedFFTFormats[]	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

FIRST_ELEMENT_NOT_ZERO

public static final LocalizedFFTFormats FIRST_ELEMENT_NOT_ZERO

NOT_POWER_OF_TWO

public static final LocalizedFFTFormats NOT_POWER_OF_TWO

NOT_POWER_OF_TWO_CONSIDER_PADDING

public static final LocalizedFFTFormats NOT_POWER_OF_TWO_CONSIDER_PADDING

NOT_POWER_OF_TWO_PLUS_ONE

public static final LocalizedFFTFormats NOT_POWER_OF_TWO_PLUS_ONE

Method Detail

values

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

Returns:

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

valueOf

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