org.encog.util

Class ParamsHolder

java.lang.Object

org.encog.util.ParamsHolder

public class ParamsHolder
extends java.lang.Object

A class that can be used to parse parameters stored in a map. Allows the params to be accessed as various data types and to be validated.

Constructor Summary

Constructors

Constructor and Description
ParamsHolder(java.util.Map<java.lang.String,java.lang.String> theParams) Construct the object.
ParamsHolder(java.util.Map<java.lang.String,java.lang.String> theParams, CSVFormat theFormat) Construct the object.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String name, boolean required, boolean defaultValue) Get a param as a boolean.
double	getDouble(java.lang.String name, boolean required, double defaultValue) Get a param as a double.
int	getInt(java.lang.String name, boolean required, int defaultValue) Get a param as a integer.
java.util.Map<java.lang.String,java.lang.String>	getParams()
java.lang.String	getString(java.lang.String name, boolean required, java.lang.String defaultValue) Get a param as a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParamsHolder

public ParamsHolder(java.util.Map<java.lang.String,java.lang.String> theParams,
                    CSVFormat theFormat)

Construct the object. Allow the format to be specified.

Parameters:

theParams - The params to be used.

theFormat - The format to be used.

ParamsHolder

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

Construct the object. Allow the format to be specified.

Parameters:

theParams - The params to be used.

Method Detail

getParams

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

Returns:

the params

getString

public java.lang.String getString(java.lang.String name,
                                  boolean required,
                                  java.lang.String defaultValue)

Get a param as a string.

Parameters:

name - The name of the string.

required - True if this value is required.

defaultValue - The default value.

Returns:

The value.

getInt

public int getInt(java.lang.String name,
                  boolean required,
                  int defaultValue)

Get a param as a integer.

Parameters:

name - The name of the integer.

required - True if this value is required.

defaultValue - The default value.

Returns:

The value.

getDouble

public double getDouble(java.lang.String name,
                        boolean required,
                        double defaultValue)

Get a param as a double.

Parameters:

name - The name of the double.

required - True if this value is required.

defaultValue - The default value.

Returns:

The value.

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean required,
                          boolean defaultValue)

Get a param as a boolean.

Parameters:

name - The name of the double.

required - True if this value is required.

defaultValue - The default value.

Returns:

The value.