com.lonniepryor.blues.cfg
Interface IncludeCfg

All Known Implementing Classes:

IncludeCfgImpl

public interface IncludeCfg

Defines the requirements for a Blues include configuration.

Version:

$Revision: 1.1 $

Author:

Lonnie Pryor

Method Summary

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.

Method Detail

getName

public java.lang.String getName()

Returns the name of this include.

Returns:

The name of this include.

getModulePath

public java.lang.String getModulePath()

Returns the path to the module configuration file.

Returns:

The path to the module configuration file.

getVariableNames

public java.lang.String[] getVariableNames()

Returns all of the variable names declared in this include.

Returns:

All of the variable names declared in this include.

getVariableRefrence

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

Returns the refrence to use for the specified variable name.

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)

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

Parameters:

module - The included module.

getIncludedModule

public ModuleCfg getIncludedModule()

Returns the included module.

Returns:

The included module.