org.safs.tools.drivers

Class ConfigureFile

java.lang.Object

org.safs.tools.drivers.ConfigureFile

All Implemented Interfaces:

ConfigureInterface

public class ConfigureFile
extends java.lang.Object
implements ConfigureInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	configFile
protected INIFileReader	reader
protected java.util.Vector	store

Constructor Summary

Constructors

Constructor and Description
ConfigureFile() Empty Constructor for Configure.
ConfigureFile(java.io.File configFile) Primary Constructor for Configure.

Method Summary

Modifier and Type	Method and Description
void	addConfigureInterface(ConfigureInterface configSource) Add a ConfigureInterface to the search chain for Named Values.
java.lang.String	getConfigurePaths() Retrieve a String containing a File.pathSeparator delimited list of all the file paths in the configuration file chain.
java.lang.String	getNamedValue(java.lang.String keyName, java.lang.String itemName) Retrieve an item that may be in the configuration sources.
void	insertConfigureInterface(ConfigureInterface configSource) Insert a ConfigureInterface to the search chain for Named Values.
void	setConfigurationFile(java.io.File configFile) The File object must represent a readable INI file and will be used to initialize an internal INIFileReader.

Methods inherited from class java.lang.Object

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

Field Detail

configFile

protected java.io.File configFile

store

protected java.util.Vector store

reader

protected INIFileReader reader

Constructor Detail

ConfigureFile

public ConfigureFile()

Empty Constructor for Configure. The instance won't be able to do anything until a valid File object representing a readable INI file has been provided via setConfigurationFile.

ConfigureFile

public ConfigureFile(java.io.File configFile)

Primary Constructor for Configure. The File object must represent a readable INI file and will be forwarded to setConfigurationFile.

Method Detail

setConfigurationFile

public void setConfigurationFile(java.io.File configFile)

The File object must represent a readable INI file and will be used to initialize an internal INIFileReader.

addConfigureInterface

public void addConfigureInterface(ConfigureInterface configSource)

Description copied from interface: ConfigureInterface

Add a ConfigureInterface to the search chain for Named Values. The item is added at the end of the chain to be searched.
This object will search its getNamedValue() before it resorts to any stored ConfigureInterface objects in the stored chain.

Specified by:

addConfigureInterface in interface ConfigureInterface

See Also:

ConfigureInterface.addConfigureInterface(ConfigureInterface)

insertConfigureInterface

public void insertConfigureInterface(ConfigureInterface configSource)

Description copied from interface: ConfigureInterface

Insert a ConfigureInterface to the search chain for Named Values. The item is inserted at the beginning of the chain to be searched.
This object will search its getNamedValue() before it resorts to any stored ConfigureInterface objects in the stored chain.

Specified by:

insertConfigureInterface in interface ConfigureInterface

See Also:

ConfigureInterface.insertConfigureInterface(ConfigureInterface)

getNamedValue

public java.lang.String getNamedValue(java.lang.String keyName,
                                      java.lang.String itemName)

Description copied from interface: ConfigureInterface

Retrieve an item that may be in the configuration sources. An item is identified by a parent key or section name--like in an INI file "section"--and the name of the item in that section.
This object will search its getNamedValue() before it resorts to any stored ConfigureInterface objects in the stored chain.

Specified by:

getNamedValue in interface ConfigureInterface

Returns:

the retrieved String value or null if no such value exists.

See Also:

ConfigureInterface.getNamedValue(String, String)

getConfigurePaths

public java.lang.String getConfigurePaths()

Description copied from interface: ConfigureInterface

Retrieve a String containing a File.pathSeparator delimited list of all the file paths in the configuration file chain.

Specified by:

getConfigurePaths in interface ConfigureInterface

See Also:

ConfigureInterface.getConfigurePaths()