com.lonniepryor.blues.cfg
Class IncludeCfgImpl

java.lang.Object
  |
  +--com.lonniepryor.blues.cfg.IncludeCfgImpl

All Implemented Interfaces:

IncludeCfg, Verifiable

public class IncludeCfgImpl

extends java.lang.Object

implements IncludeCfg, Verifiable

Generic implementation of IncludeCfg.

Version:

$Revision: 1.1 $

Author:

Lonnie Pryor

Nested Class Summary

static class

IncludeCfgImpl.SetVariableCfg Child element for setting variable refrences.

Constructor Summary

IncludeCfgImpl()
Creates a new IncludeCfgImpl object.

Method Summary

void	declareSetVariable(IncludeCfgImpl.SetVariableCfg variable) Declares a variable name/refrence pair on this include.
ModuleCfg	getIncludedModule() Returns the included module.
java.lang.String	getModulePath() Returns the path to the module configuration file.
java.lang.String	getName() Returns the name of this include.
java.lang.String[]	getVariableNames() Returns all of the variable names declared in this include.
java.lang.String	getVariableRefrence(java.lang.String variableName) Returns the refrence to use for the specified variable name.
void	initIncludedModule(ModuleCfg module) Initalizes the refrence to the included module once it is loaded.
void	setName(java.lang.String name) Sets the name given to the module to include.
void	setPath(java.lang.String modulePath) Sets the path to the module configuration.
void	verify() Verifies the state of this configuration element.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeCfgImpl

public IncludeCfgImpl()

Creates a new IncludeCfgImpl object.

Method Detail

setName

public void setName(java.lang.String name)

Sets the name given to the module to include.

Parameters:

name - The name given to the module to include.

setPath

public void setPath(java.lang.String modulePath)

Sets the path to the module configuration.

Parameters:

modulePath - The path to the module configuration.

declareSetVariable

public void declareSetVariable(IncludeCfgImpl.SetVariableCfg variable)

Declares a variable name/refrence pair on this include.

Parameters:

variable - The variable configuration.

verify

public void verify()

Description copied from interface: Verifiable

Verifies the state of this configuration element.

Specified by:

verify in interface Verifiable

getName

public java.lang.String getName()

Description copied from interface: IncludeCfg

Returns the name of this include.

Specified by:

getName in interface IncludeCfg

Returns:

The name of this include.

getModulePath

public java.lang.String getModulePath()

Description copied from interface: IncludeCfg

Returns the path to the module configuration file.

Specified by:

getModulePath in interface IncludeCfg

Returns:

The path to the module configuration file.

getVariableNames

public java.lang.String[] getVariableNames()

Description copied from interface: IncludeCfg

Returns all of the variable names declared in this include.

Specified by:

getVariableNames in interface IncludeCfg

Returns:

All of the variable names declared in this include.

getVariableRefrence

public java.lang.String getVariableRefrence(java.lang.String variableName)

Description copied from interface: IncludeCfg

Returns the refrence to use for the specified variable name.

Specified by:

getVariableRefrence in interface IncludeCfg

Parameters:

variableName - The name of the variable to resolve.

Returns:

The refrence to use for the specified variable name.

initIncludedModule

public void initIncludedModule(ModuleCfg module)

Description copied from interface: IncludeCfg

Initalizes the refrence to the included module once it is loaded.

Specified by:

initIncludedModule in interface IncludeCfg

Parameters:

module - The included module.

getIncludedModule

public ModuleCfg getIncludedModule()

Description copied from interface: IncludeCfg

Returns the included module.

Specified by:

getIncludedModule in interface IncludeCfg

Returns:

The included module.