org.lsst.ccs.subsystems.shutter

Class ConfigDataChecker<T>

java.lang.Object

org.lsst.ccs.subsystems.shutter.ConfigDataChecker<T>

public final class ConfigDataChecker<T>
extends Object

Checks configuration data against a reference for names and types. A set of configuration data, represented as a Map<String, String> will be checked against a reference Constructor. Where the constructor specifies int/long or Integer/Long, Integer/Long.decode(String) is used to check and convert. For Double values Double.valueOf(String) is used. For enums, the string is converted to uppercase and then appropriate {@code valueOf(String)} method is used.

Author:

tether

Constructor Summary

Constructors

Constructor and Description
ConfigDataChecker(Constructor<T> construct) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	checkAllPresent(Map<String,String> config) Checks for missing data by key.
List<String>	checkAllTypes(Map<String,String> config) Checks that configuration data items have the right types.
T	convertAll(Map<String,String> config) Converts the set of configuration data items to an object of type T, provided that none are missing or invalid.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDataChecker

public ConfigDataChecker(Constructor<T> construct)

Constructor.

Parameters:

reference - The reference constructor against which to check a configuration.

Method Detail

checkAllPresent

public List<String> checkAllPresent(Map<String,String> config)

Checks for missing data by key.

Parameters:

config - The configuration data to be checked.

Returns:

A list of the names of missing items.

checkAllTypes

public List<String> checkAllTypes(Map<String,String> config)

Checks that configuration data items have the right types. It's assumed that no items are missing.

Parameters:

config - The configuration data to check.

Returns:

A list of error messages for items that didn't check out.

See Also:

checkAllPresent(java.util.Map)

convertAll

public T convertAll(Map<String,String> config)

Converts the set of configuration data items to an object of type T, provided that none are missing or invalid. Items that are not required to be of enum type are passed along unchanged; enum strings are converted with the correct valueOf() method.

Parameters:

config - The configuration data to convert.

Returns:

The list of converted items.

See Also:

checkAllPresent(java.util.Map), checkAllTypes(java.util.Map)