ValidatingPreferencesWrapper (AludraTest 3.0.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.aludratest.config
Class ValidatingPreferencesWrapper

java.lang.Object
  org.aludratest.config.ValidatingPreferencesWrapper

All Implemented Interfaces:: Preferences

public final class ValidatingPreferencesWrapper
extends Object
implements Preferences
extends Object
implements Preferences

Helper class for Preferences consumers which can be used to have getter methods which validate the existence of a configuration property when trying to retrieve it. Clients can wrap an existing Preferences object with this class and use its methods.
Queried child nodes are automatically wrapped and returned as ValidatingPreferencesWrapper.

Author:: falbrech

Constructor Summary
`ValidatingPreferencesWrapper(Preferences delegate)` Creates a new ValidatingPreferencesWrapper object which wraps the given Preferences object.

Method Summary
`boolean`	`getBooleanValue(String key)` Returns the boolean representation of the given configuration key's value.
`boolean`	`getBooleanValue(String key, boolean defaultValue)` Returns the boolean representation of the given configuration key's value, or the given default value when no value is stored for this key, or the stored String form of the value is `null`.
`char`	`getCharValue(String key)` Returns the char representation of the given configuration key's value.
`char`	`getCharValue(String key, char defaultValue)` Returns the char representation of the given configuration key's value, or the given default value when no value is stored for this key, or the stored String form of the value is `null`.
`ValidatingPreferencesWrapper`	`getChildNode(String name)` Returns the configuration child node with the given name, or `null` if no such node exists on this configuration node.
`String[]`	`getChildNodeNames()` Returns the names of the available configuration child nodes on this configuration node.
`double`	`getDoubleValue(String key)` Returns the double representation of the given configuration key's value.
`double`	`getDoubleValue(String key, double defaultValue)` Returns the double representation of the given configuration key's value, or the given default value when no value is stored for this key, or the stored String form of the value is `null`.
`float`	`getFloatValue(String key)` Returns the float representation of the given configuration key's value.
`float`	`getFloatValue(String key, float defaultValue)` Returns the float representation of the given configuration key's value, or the given default value when no value is stored for this key, or the stored String form of the value is `null`.
`int`	`getIntValue(String key)` Returns the int representation of the given configuration key's value.
`int`	`getIntValue(String key, int defaultValue)` Returns the int representation of the given configuration key's value, or the given default value when no value is stored for this key, or the stored String form of the value is `null`.
`String[]`	`getKeyNames()` Returns the available configuration key names on this Preferences node.
`boolean`	`getRequiredBooleanValue(String key)` Returns the boolean representation of the given configuration key's value.
`char`	`getRequiredCharValue(String key)` Returns the char representation of the given configuration key's value.
`double`	`getRequiredDoubleValue(String key)` Returns the double representation of the given configuration key's value.
`float`	`getRequiredFloatValue(String key)` Returns the float representation of the given configuration key's value.
`int`	`getRequiredIntValue(String key)` Returns the int representation of the given configuration key's value.
`String`	`getRequiredStringValue(String key)` Returns the String representation of the given configuration key's value.
`String`	`getStringValue(String key)` Returns the String representation of the given configuration key's value.
`String`	`getStringValue(String key, String defaultValue)` Returns the String representation of the given configuration key's value, or the given default value when no value is stored for this key, or the stored value is `null`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ValidatingPreferencesWrapper

public ValidatingPreferencesWrapper(Preferences delegate)

Creates a new ValidatingPreferencesWrapper object which wraps the given Preferences object.

Parameters:: delegate - Preferences node to wrap.

Method Detail

getRequiredStringValue

public String getRequiredStringValue(String key)

Returns the String representation of the given configuration key's value. If the configuration key does not exist on this Preferences node, or if its value is null, an AutomationException is thrown.

Parameters:: key - Configuration key to retrieve the value of.
Returns:: The value of the configuration key, as a String.

getRequiredIntValue

public int getRequiredIntValue(String key)

Returns the int representation of the given configuration key's value. If the configuration key does not exist on this Preferences node, or if its stored String value is null, an AutomationException is thrown.

Parameters:: key - Configuration key to retrieve the value of.
Returns:: The value of the configuration key, as an int.

getRequiredDoubleValue

public double getRequiredDoubleValue(String key)

Returns the double representation of the given configuration key's value. If the configuration key does not exist on this Preferences node, or if its stored String value is null, an AutomationException is thrown.

Parameters:: key - Configuration key to retrieve the value of.
Returns:: The value of the configuration key, as a double.

getRequiredFloatValue

public float getRequiredFloatValue(String key)

Returns the float representation of the given configuration key's value. If the configuration key does not exist on this Preferences node, or if its stored String value is null, an AutomationException is thrown.

Parameters:: key - Configuration key to retrieve the value of.
Returns:: The value of the configuration key, as a float.

getRequiredBooleanValue

public boolean getRequiredBooleanValue(String key)

Returns the boolean representation of the given configuration key's value. If the configuration key does not exist on this Preferences node, or if its stored String value is null, an AutomationException is thrown.

Parameters:: key - Configuration key to retrieve the value of.
Returns:: The value of the configuration key, as a boolean.

getRequiredCharValue

public char getRequiredCharValue(String key)

Returns the char representation of the given configuration key's value. If the configuration key does not exist on this Preferences node, or if its stored String value is null, an AutomationException is thrown.

Parameters:: key - Configuration key to retrieve the value of.
Returns:: The value of the configuration key, as a char.