Package adams.console

Class AbstractConsoleApplication

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.console.AbstractConsoleApplication

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

Logging

public abstract class AbstractConsoleApplication
extends AbstractOptionHandler

Ancestor for simple console applications.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractConsoleApplication()

Method Summary

Modifier and Type	Method	Description
protected abstract String	execute()	Executes the application.
static AbstractConsoleApplication	forCommandLine(String cmdline)	Instantiates the application from the given commandline (i.e., classname and optional options).
static AbstractConsoleApplication	forName(String classname, String[] options)	Instantiates the application with the given options.
static void	runApplication(Class env, Class app, String[] options)	Runs the application from the commandline.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractConsoleApplication

public AbstractConsoleApplication()

Method Detail

execute

protected abstract String execute()

Executes the application.

Returns:

null if successful, otherwise error message

forName

public static AbstractConsoleApplication forName(String classname,
                                                 String[] options)

Instantiates the application with the given options.

Parameters:

classname - the classname of the application to instantiate

options - the options for the application

Returns:

the instantiated application or null if an error occurred

forCommandLine

public static AbstractConsoleApplication forCommandLine(String cmdline)

Instantiates the application from the given commandline (i.e., classname and optional options).

Parameters:

cmdline - the classname (and optional options) of the application to instantiate

Returns:

the instantiated application or null if an error occurred

runApplication

public static void runApplication(Class env,
                                  Class app,
                                  String[] options)

Runs the application from the commandline. Calling code needs to perform a System.exit(0).

Parameters:

env - the environment class to use

app - the application frame class

options - the commandline options