gov.nasa.pds.tools.util

Enum SettingsManager

java.lang.Object

java.lang.Enum<SettingsManager>

gov.nasa.pds.tools.util.SettingsManager

All Implemented Interfaces:

Serializable, Comparable<SettingsManager>

public enum SettingsManager
extends Enum<SettingsManager>

Implements a class that manages settings for an application.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
String	getString(String key, String defaultValue) Gets a string settings identified by a key, or a default value if the setting has no specified value.
static SettingsManager	valueOf(String name) Returns the enum constant of this type with the specified name.
static SettingsManager[]	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

INSTANCE

public static final SettingsManager INSTANCE

Method Detail

values

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

Returns:

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

valueOf

public static SettingsManager 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

getString

public String getString(String key,
               String defaultValue)

Gets a string settings identified by a key, or a default value if the setting has no specified value.

Parameters:

key - the key for the setting

defaultValue - the default value

Returns:

the setting value, or the default if not specified