edu.iu.dsc.tws.deeplearning.common

Class ParameterTool

java.lang.Object

edu.iu.dsc.tws.deeplearning.common.ParameterTool

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class ParameterTool
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This class provides simple utility methods for reading and parsing program arguments from different sources.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	data
protected static java.lang.String	DEFAULT_UNDEFINED
protected java.util.Map<java.lang.String,java.lang.String>	defaultData
protected static java.lang.String	NO_VALUE_KEY
protected java.util.Set<java.lang.String>	unrequestedParameters

Method Summary

Modifier and Type	Method and Description
protected void	addToDefaults(java.lang.String key, java.lang.String value)
static <T> T	checkNotNull(T reference, java.lang.String errorMessage)
void	createPropertiesFile(java.lang.String pathToFile) Create a properties file with all the known parameters (call after the last get*() call).
void	createPropertiesFile(java.lang.String pathToFile, boolean overwrite) Create a properties file with all the known parameters (call after the last get*() call).
boolean	equals(java.lang.Object o)
static ParameterTool	fromArgs(java.lang.String[] args) Returns ParameterTool for the given arguments.
static ParameterTool	fromMap(java.util.Map<java.lang.String,java.lang.String> map) Returns ParameterTool for the given map.
static ParameterTool	fromPropertiesFile(java.io.File file) Returns ParameterTool for the given Properties file.
static ParameterTool	fromPropertiesFile(java.io.InputStream inputStream) Returns ParameterTool for the given InputStream from Properties file.
static ParameterTool	fromPropertiesFile(java.lang.String path) Returns ParameterTool for the given Properties file.
static ParameterTool	fromSystemProperties() Returns ParameterTool from the system properties.
java.lang.String	get(java.lang.String key) Returns the String value for the given key.
java.lang.String	get(java.lang.String key, java.lang.String defaultValue) Returns the String value for the given key.
boolean	getBoolean(java.lang.String key) Returns the Boolean value for the given key.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns the Boolean value for the given key.
byte	getByte(java.lang.String key) Returns the Byte value for the given key.
byte	getByte(java.lang.String key, byte defaultValue) Returns the Byte value for the given key.
JobConfig	getConfiguration()
double	getDouble(java.lang.String key) Returns the Double value for the given key.
double	getDouble(java.lang.String key, double defaultValue) Returns the Double value for the given key.
float	getFloat(java.lang.String key) Returns the Float value for the given key.
float	getFloat(java.lang.String key, float defaultValue) Returns the Float value for the given key.
int	getInt(java.lang.String key) Returns the Integer value for the given key.
int	getInt(java.lang.String key, int defaultValue) Returns the Integer value for the given key.
long	getLong(java.lang.String key) Returns the Long value for the given key.
long	getLong(java.lang.String key, long defaultValue) Returns the Long value for the given key.
int	getNumberOfParameters() Returns number of parameters in ParameterTool.
java.util.Properties	getProperties() Returns a Properties object from this ParameterTool.
java.lang.String	getRequired(java.lang.String key) Returns the String value for the given key.
short	getShort(java.lang.String key) Returns the Short value for the given key.
short	getShort(java.lang.String key, short defaultValue) Returns the Short value for the given key.
java.util.Set<java.lang.String>	getUnrequestedParameters() Returns the set of parameter names which have not been requested with has(String) or one of the get methods.
boolean	has(java.lang.String value) Check if value is set.
int	hashCode()
ParameterTool	mergeWith(ParameterTool other) Merges two ParameterTool.
java.util.Map<java.lang.String,java.lang.String>	toMap()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_VALUE_KEY

protected static final java.lang.String NO_VALUE_KEY

See Also:

Constant Field Values

DEFAULT_UNDEFINED

protected static final java.lang.String DEFAULT_UNDEFINED

See Also:

Constant Field Values

data

protected final java.util.Map<java.lang.String,java.lang.String> data

defaultData

protected transient java.util.Map<java.lang.String,java.lang.String> defaultData

unrequestedParameters

protected transient java.util.Set<java.lang.String> unrequestedParameters

Method Detail

fromArgs

public static ParameterTool fromArgs(java.lang.String[] args)

Returns ParameterTool for the given arguments. The arguments are keys followed by values. Keys have to start with '-' or '--'

Example arguments: --key1 value1 --key2 value2 -key3 value3

Parameters:

args - Input array arguments

Returns:

A ParameterTool

fromPropertiesFile

public static ParameterTool fromPropertiesFile(java.lang.String path)
                                        throws java.io.IOException

Returns ParameterTool for the given Properties file.

Parameters:

path - Path to the properties file

Returns:

A ParameterTool

Throws:

java.io.IOException - If the file does not exist

See Also:

Properties

fromPropertiesFile

public static ParameterTool fromPropertiesFile(java.io.File file)
                                        throws java.io.IOException

Returns ParameterTool for the given Properties file.

Parameters:

file - File object to the properties file

Returns:

A ParameterTool

Throws:

java.io.IOException - If the file does not exist

See Also:

Properties

fromPropertiesFile

public static ParameterTool fromPropertiesFile(java.io.InputStream inputStream)
                                        throws java.io.IOException

Returns ParameterTool for the given InputStream from Properties file.

Parameters:

inputStream - InputStream from the properties file

Returns:

A ParameterTool

Throws:

java.io.IOException - If the file does not exist

See Also:

Properties

checkNotNull

public static <T> T checkNotNull(T reference,
                                 java.lang.String errorMessage)

fromMap

public static ParameterTool fromMap(java.util.Map<java.lang.String,java.lang.String> map)

Returns ParameterTool for the given map.

Parameters:

map - A map of arguments. Both Key and Value have to be Strings

Returns:

A ParameterTool

fromSystemProperties

public static ParameterTool fromSystemProperties()

Returns ParameterTool from the system properties. Example on how to pass system properties: -Dkey1=value1 -Dkey2=value2

Returns:

A ParameterTool

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getUnrequestedParameters

public java.util.Set<java.lang.String> getUnrequestedParameters()

Returns the set of parameter names which have not been requested with has(String) or one of the get methods. Access to the map returned by toMap() is not tracked.

getNumberOfParameters

public int getNumberOfParameters()

Returns number of parameters in ParameterTool.

get

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

Returns the String value for the given key. If the key does not exist it will return null.

getRequired

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

Returns the String value for the given key. If the key does not exist it will throw a RuntimeException.

get

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

Returns the String value for the given key. If the key does not exist it will return the given default value.

has

public boolean has(java.lang.String value)

Check if value is set.

getInt

public int getInt(java.lang.String key)

Returns the Integer value for the given key. The method fails if the key does not exist or the value is not an Integer.

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Returns the Integer value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not an Integer.

getLong

public long getLong(java.lang.String key)

Returns the Long value for the given key. The method fails if the key does not exist.

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Returns the Long value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Long.

getFloat

public float getFloat(java.lang.String key)

Returns the Float value for the given key. The method fails if the key does not exist.

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Returns the Float value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Float.

getDouble

public double getDouble(java.lang.String key)

Returns the Double value for the given key. The method fails if the key does not exist.

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Returns the Double value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Double.

getBoolean

public boolean getBoolean(java.lang.String key)

Returns the Boolean value for the given key. The method fails if the key does not exist.

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Returns the Boolean value for the given key. If the key does not exists it will return the default value given. The method returns whether the string of the value is "true" ignoring cases.

getShort

public short getShort(java.lang.String key)

Returns the Short value for the given key. The method fails if the key does not exist.

getShort

public short getShort(java.lang.String key,
                      short defaultValue)

Returns the Short value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Short.

getByte

public byte getByte(java.lang.String key)

Returns the Byte value for the given key. The method fails if the key does not exist.

getByte

public byte getByte(java.lang.String key,
                    byte defaultValue)

Returns the Byte value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Byte.

addToDefaults

protected void addToDefaults(java.lang.String key,
                             java.lang.String value)

getConfiguration

public JobConfig getConfiguration()

getProperties

public java.util.Properties getProperties()

Returns a Properties object from this ParameterTool.

Returns:

A Properties

createPropertiesFile

public void createPropertiesFile(java.lang.String pathToFile)
                          throws java.io.IOException

Create a properties file with all the known parameters (call after the last get*() call). Set the default value, if available.

Use this method to create a properties file skeleton.

Parameters:

pathToFile - Location of the default properties file.

Throws:

java.io.IOException

createPropertiesFile

public void createPropertiesFile(java.lang.String pathToFile,
                                 boolean overwrite)
                          throws java.io.IOException

Create a properties file with all the known parameters (call after the last get*() call). Set the default value, if overwrite is true.

Parameters:

pathToFile - Location of the default properties file.

overwrite - Boolean flag indicating whether or not to overwrite the file

Throws:

java.io.IOException - If overwrite is not allowed and the file exists

mergeWith

public ParameterTool mergeWith(ParameterTool other)

Merges two ParameterTool.

Parameters:

other - Other ParameterTool object

Returns:

The Merged ParameterTool

toMap

public java.util.Map<java.lang.String,java.lang.String> toMap()