net.officefloor.building.console

Class OfficeFloorConsoleMain

java.lang.Object

net.officefloor.building.console.OfficeFloorConsoleMain

public final class OfficeFloorConsoleMain
extends Object

Provides the main entrance point to running OfficeFloorCommand.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler Interface to error handler for OfficeFloorConsoleMain.

Field Summary

Fields

Modifier and Type	Field and Description
static OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler	DEFAULT_ERROR_HANDLER Default OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler.
static boolean	isExit Flags that System.exit(int) is called on an error to indicate failure to calling script.
static String	OFFICE_FLOOR_HOME Environment property to specify where the OfficeFloor home directory is located.
static String	PROPERTIES_FILE_RELATIVE_PATH Relative path from the OFFICE_FLOOR_HOME to find the properties file.

Constructor Summary

Constructors

Constructor and Description
OfficeFloorConsoleMain()

Method Summary

Modifier and Type	Method and Description
static void	main(String[] arguments) Entrance point for running an OfficeFloorCommand.
static void	run(String scriptName, String[] executeArguments, OfficeFloorConsoleFactory factory, OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler errorHandler) Runs the OfficeFloorConsole.

Methods inherited from class java.lang.Object

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

Field Detail

OFFICE_FLOOR_HOME

public static final String OFFICE_FLOOR_HOME

Environment property to specify where the OfficeFloor home directory is located.

See Also:

Constant Field Values

PROPERTIES_FILE_RELATIVE_PATH

public static final String PROPERTIES_FILE_RELATIVE_PATH

Relative path from the OFFICE_FLOOR_HOME to find the properties file.

See Also:

Constant Field Values

DEFAULT_ERROR_HANDLER

public static final OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler DEFAULT_ERROR_HANDLER

Default OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler.

isExit

public static boolean isExit

Flags that System.exit(int) is called on an error to indicate failure to calling script.

This is typically only used for testing to not cause the JVM to exit while running tests that are expected to error.

Constructor Detail

OfficeFloorConsoleMain

public OfficeFloorConsoleMain()

Method Detail

main

public static void main(String[] arguments)
                 throws Throwable

Entrance point for running an OfficeFloorCommand.

Parameters:

arguments - Command line arguments.

Throws:

Throwable - If fails to run the OfficeFloorCommand.

run

public static void run(String scriptName,
                       String[] executeArguments,
                       OfficeFloorConsoleFactory factory,
                       OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler errorHandler)
                throws Exception

Runs the OfficeFloorConsole.

Parameters:

scriptName - Name of script.

executeArguments - Execute arguments for the OfficeFloorConsole.

factory - OfficeFloorConsoleFactory.

errorHandler - OfficeFloorConsoleMain.OfficeFloorConsoleMainErrorHandler.

Throws:

Exception - If fails to run.