com.neeve.config

Class ConfigTool

java.lang.Object

com.neeve.config.ConfigObject

com.neeve.config.ConfigTool

Direct Known Subclasses:

ConfigTool

public class ConfigTool
extends ConfigObject

The X Platform configuration tool

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ConfigTool.Commit
class	ConfigTool.CreateComplexEntity
class	ConfigTool.CreateComplexEntityContainer
class	ConfigTool.CreateSimpleEntity
class	ConfigTool.CreateSimpleEntityContainer
class	ConfigTool.DeleteComplexEntity
class	ConfigTool.DeleteComplexEntityContainer
class	ConfigTool.DeleteSimpleEntity
class	ConfigTool.DeleteSimpleEntityContainer
class	ConfigTool.Dump
class	ConfigTool.DumpComplexEntity
class	ConfigTool.DumpComplexEntityContainer
class	ConfigTool.DumpSimpleEntity
class	ConfigTool.DumpSimpleEntityContainer
class	ConfigTool.Scriptify
class	ConfigTool.SetComplexEntityProperty
class	ConfigTool.SetSimpleEntityProperty
class	ConfigTool.Trace

Constructor Summary

Constructors

Constructor and Description
ConfigTool(IConfigRepository repo, Tracer.Level traceLevel) Construct an instance of the tool using an repository.
ConfigTool(String configDescriptor, boolean createRepo) Construct an instance of the tool using the default trace level.

Method Summary

Modifier and Type	Method and Description
IConfigRepository	getConfigRepository() Get the configuration repository that this config tool is working with
com.neeve.tools.interactive.InteractiveTool	getInteractiveTool() Get the interactive tool that this config tool is working with
void	run(File scriptFile) Run taking command input from a script file or stdin.
void	run(InputStream in) Run taking command input from a buffered reader.

Methods inherited from class com.neeve.config.ConfigObject

getTracer

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigTool

public ConfigTool(IConfigRepository repo,
                  Tracer.Level traceLevel)
           throws Exception

Construct an instance of the tool using an repository.

Parameters:

repo - The repository to use.

traceLevel - The tool's initial trace level.

Throws:

Exception

ConfigTool

public ConfigTool(String configDescriptor,
                  boolean createRepo)
           throws Exception

Construct an instance of the tool using the default trace level.

This constructor invokes this(configDescriptor, createRepo, Tracer.Level.Info}

Throws:

Exception

Method Detail

getInteractiveTool

public final com.neeve.tools.interactive.InteractiveTool getInteractiveTool()

Get the interactive tool that this config tool is working with

getConfigRepository

public final IConfigRepository getConfigRepository()

Get the configuration repository that this config tool is working with

run

public final void run(InputStream in)
               throws Exception

Run taking command input from a buffered reader.

Parameters:

in - The InputStream to take input from.

Use this method to feed a set of commands to the configuration tool for batch execution.

Throws:

Exception

run

public final void run(File scriptFile)
               throws Exception

Run taking command input from a script file or stdin.

Parameters:

scriptFile - The script file or null for stdin

Use this method to either start the tool in interactive mode (scriptFile=null) or feed a set of commands to the configuration tool from a file for batch execution.

Throws:

Exception