de.softdevel.d1.datapool

Class CDatapoolHelper

java.lang.Object

de.softdevel.d1.datapool.CDatapoolHelper

public final class CDatapoolHelper
extends java.lang.Object

A Helper for converting Strings.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MISSING Missing value.
static int	WRONGFORMAT Wrong Format.

Method Summary

Modifier and Type	Method and Description
static boolean	getBoolean(IDatapool aDp, java.lang.String aPath, java.lang.String aKey) Get a boolean from the datapool.
static boolean	getBoolean(IDatapool aDp, java.lang.String aPath, java.lang.String aKey, boolean aDefault) Get a boolean from the datapool.
static java.lang.String	getCombinedKey(java.lang.String aPath, java.lang.String aKey) Create a combined key from the path and the key of a datapool record.
static int	getInteger(IDatapool aDp, java.lang.String aPath, java.lang.String aKey) Get an integer from the datapool.
static int	getInteger(IDatapool aDp, java.lang.String aPath, java.lang.String aKey, int aDefault) Get an integer from the datapool.
static long	getLong(IDatapool aDp, java.lang.String aPath, java.lang.String aKey) Get a long value from the datapool.
static long	getLong(IDatapool aDp, java.lang.String aPath, java.lang.String aKey, long aDefault) Get a long value from the datapool.

Methods inherited from class java.lang.Object

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

Field Detail

MISSING

public static final int MISSING

Missing value.

See Also:

Constant Field Values

WRONGFORMAT

public static final int WRONGFORMAT

Wrong Format.

See Also:

Constant Field Values

Method Detail

getBoolean

public static boolean getBoolean(IDatapool aDp,
                                 java.lang.String aPath,
                                 java.lang.String aKey)

Get a boolean from the datapool. If the variable is in a wrong format, a message will be logged.

Parameters:

aDp - The datapool.

aPath - The path.

aKey - The key.

Returns:

False if a value is missing, otherwise the value.

getBoolean

public static boolean getBoolean(IDatapool aDp,
                                 java.lang.String aPath,
                                 java.lang.String aKey,
                                 boolean aDefault)

Get a boolean from the datapool.

Parameters:

aDp - The datapool.

aPath - The path.

aKey - The key.

aDefault - Default value

Returns:

aDefault if a value is missing, WRONGFORMAT on invalid format, otherwise the value

getCombinedKey

public static java.lang.String getCombinedKey(java.lang.String aPath,
                                              java.lang.String aKey)

Create a combined key from the path and the key of a datapool record.
Example: aPath/aKey

Parameters:

aPath - The path of a datapool record.

aKey - The key of a datapool record.

Returns:

The combined key: aPath/aKey.

getInteger

public static int getInteger(IDatapool aDp,
                             java.lang.String aPath,
                             java.lang.String aKey)

Get an integer from the datapool. If the variable is in a wrong format, a message will be logged.

Parameters:

aDp - The datapool.

aPath - The path.

aKey - The key.

Returns:

MISSING if a value is missing, WRONGFORMAT on invalid format, otherwise the value.

getInteger

public static int getInteger(IDatapool aDp,
                             java.lang.String aPath,
                             java.lang.String aKey,
                             int aDefault)

Get an integer from the datapool. If the variable is in a wrong format, a message will be logged.

Parameters:

aDp - The datapool.

aPath - The path.

aKey - The key.

aDefault - Default value

Returns:

aDefault if a value is missing, WRONGFORMAT on invalid format, otherwise the value

getLong

public static long getLong(IDatapool aDp,
                           java.lang.String aPath,
                           java.lang.String aKey)

Get a long value from the datapool. If the variable is in a wrong format, a message will be logged.

Parameters:

aDp - The datapool.

aPath - The path.

aKey - The key.

Returns:

MISSING if a value is missing, WRONGFORMAT on invalid format, otherwise the value.

getLong

public static long getLong(IDatapool aDp,
                           java.lang.String aPath,
                           java.lang.String aKey,
                           long aDefault)

Get a long value from the datapool. If the variable is in a wrong format, a message will be logged.

Parameters:

aDp - The datapool.

aPath - The path.

aKey - The key.

aDefault - Default value

Returns:

aDefault if a value is missing, WRONGFORMAT on invalid format, otherwise the value