jcckit.util
Interface ConfigData

All Known Implementing Classes:
ConfigParametersBasedConfigData, FlatConfigData

public interface ConfigData

Interface for hierarchically managed key-value pairs. The key is always a string which contains any kind of printable character except '/', '=', ':', and whitespace characters like ' ' and '\t'. The value is either a string or a ConfigData object.

This interface will be used by ConfigParameters in accordance with the Strategy design pattern.

Author:
Franz-Josef Elmer

Method Summary
 java.lang.String get(java.lang.String key)
          Returns the value associated with this key.
 java.lang.String getFullKey(java.lang.String key)
          Returns the full key.
 ConfigData getNode(java.lang.String key)
          Returns the ConfigData object associated with this key.
 

Method Detail

getFullKey

public java.lang.String getFullKey(java.lang.String key)
Returns the full key.

Parameters:
key - A (relative) key. null is not allowed.
Returns:
the full key including path.

get

public java.lang.String get(java.lang.String key)
Returns the value associated with this key.

Parameters:
key - The relative key. null is not allowed.
Returns:
the associated value. Will be null if no value exists for key.

getNode

public ConfigData getNode(java.lang.String key)
Returns the ConfigData object associated with this key.

Parameters:
key - The relative key. null is not allowed.
Returns:
the associated value. Will never return null. Instead an empty ConfigData is returned.