edu.umass.cs.utils

Class Config

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

edu.umass.cs.utils.Config

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class Config
extends java.util.Properties

Author:

arun

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Config.CLIOption An interface that makes it convenient to use commons-CLI style option while defining all fields as an enum at one place.
static interface	Config.ConfigurableEnum
static interface	Config.DefaultValueEnum
static interface	Config.Disableable Used to disallow some parameters from being configured during production runs but allow them to be configured for testing or instrumentation purposes.

Field Summary

Fields inherited from class java.util.Properties

defaults

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key)
static Config	disableCommandLine(java.lang.Class<?> type) Disable command-line input for type.
java.lang.Object	get(java.lang.Enum<?> field)
java.lang.Object	get(java.lang.Object key)
boolean	getBoolean(java.lang.Enum<?> field)
static Config	getConfig(java.lang.Class<?> type)
static java.lang.Object	getGlobal(java.lang.Enum<?> field)
static boolean	getGlobalBoolean(java.lang.Enum<?> field)
static double	getGlobalDouble(java.lang.Enum<?> field)
static int	getGlobalInt(java.lang.Enum<?> field)
static long	getGlobalLong(java.lang.Enum<?> field)
static short	getGlobalShort(java.lang.Enum<?> field)
static java.lang.String	getGlobalString(java.lang.Enum<?> field)
int	getInt(java.lang.Enum<?> field)
static java.util.logging.Logger	getLogger()
long	getLong(java.lang.Enum<?> field)
static java.util.Properties	getProperties(java.lang.Class<?> type, java.lang.String systemPropertyKey, java.lang.String defaultConfigFile)
java.lang.String	getProperty(java.lang.String key)
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue)
short	getShort(java.lang.Enum<?> field)
java.lang.String	getString(java.lang.Enum<?> field)
static void	main(java.lang.String[] args) Runtime usage of Config through explicit object instance creation.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) The methods put(Object, Object), getProperty(String), and getProperty(String, String) below make this Config case-insensitive.
static Config	register(java.lang.Class<?> type, java.lang.String systemPropertyKey, java.lang.String defaultConfigFile) Will first look for the file name specified in systemProperty and then try the configFile.
static java.util.HashMap<?,?>	register(java.lang.String[] args) For registering command-line args.
static void	setCaseSensitive(boolean b) Makes Config keys case-sensitive if b is true.
Config	setSystemProperties()

Methods inherited from class java.util.Properties

list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

register

public static Config register(java.lang.Class<?> type,
                              java.lang.String systemPropertyKey,
                              java.lang.String defaultConfigFile)
                       throws java.io.IOException

Will first look for the file name specified in systemProperty and then try the configFile.

Parameters:

type -

defaultConfigFile -

systemPropertyKey -

Returns:

Registered config object for this type.

Throws:

java.io.IOException

register

public static java.util.HashMap<?,?> register(java.lang.String[] args)

For registering command-line args.

Parameters:

args -

Returns:

Config object with updated config parameters.

getConfig

public static Config getConfig(java.lang.Class<?> type)

Parameters:

type -

Returns:

Config object registered for type.

getProperties

public static java.util.Properties getProperties(java.lang.Class<?> type,
                                                 java.lang.String systemPropertyKey,
                                                 java.lang.String defaultConfigFile)
                                          throws java.io.IOException

Parameters:

type -

systemPropertyKey -

defaultConfigFile -

Returns:

Properties object created afresh and is case-sensitive.

Throws:

java.io.IOException

setSystemProperties

public Config setSystemProperties()

Returns:

this

getGlobal

public static java.lang.Object getGlobal(java.lang.Enum<?> field)

Parameters:

field -

Returns:

The configuration value of field if its type was previously registered. If it was not previously registered, an exception will be thrown.

getGlobalBoolean

public static boolean getGlobalBoolean(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Boolean config parameter.

getGlobalInt

public static int getGlobalInt(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Integer config parameter.

getGlobalLong

public static long getGlobalLong(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Long config parameter.

getGlobalDouble

public static double getGlobalDouble(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Double config parameter.

getGlobalShort

public static short getGlobalShort(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Short config parameter.

getGlobalString

public static java.lang.String getGlobalString(java.lang.Enum<?> field)

Parameters:

field -

Returns:

String config parameter.

get

public java.lang.Object get(java.lang.Enum<?> field)

Parameters:

field -

Returns:

The configuration value of field.

getBoolean

public boolean getBoolean(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Boolean value of field.

getInt

public int getInt(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Integer value of field.

getLong

public long getLong(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Long value of field.

getShort

public short getShort(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Long value of field.

getString

public java.lang.String getString(java.lang.Enum<?> field)

Parameters:

field -

Returns:

Long value of field.

disableCommandLine

public static Config disableCommandLine(java.lang.Class<?> type)

Disable command-line input for type.

Parameters:

type -

Returns:

Config object for type.

setCaseSensitive

public static void setCaseSensitive(boolean b)

Makes Config keys case-sensitive if b is true.

Parameters:

b -

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

The methods put(Object, Object), getProperty(String), and getProperty(String, String) below make this Config case-insensitive.

Specified by:

put in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

put in class java.util.Hashtable<java.lang.Object,java.lang.Object>

getProperty

public java.lang.String getProperty(java.lang.String key)

Overrides:

getProperty in class java.util.Properties

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

get in class java.util.Hashtable<java.lang.Object,java.lang.Object>

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

Overrides:

getProperty in class java.util.Properties

containsKey

public boolean containsKey(java.lang.String key)

Parameters:

key -

Returns:

True of key present.

getLogger

public static java.util.logging.Logger getLogger()

Returns:

Local logger.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Runtime usage of Config through explicit object instance creation.

Parameters:

args -

Throws:

java.io.IOException