net.officefloor.console.command

Class OpenOfficeConsoleCommand

java.lang.Object

net.officefloor.console.command.OpenOfficeConsoleCommand

All Implemented Interfaces:

OfficeFloorCommand, OfficeFloorCommandFactory

public class OpenOfficeConsoleCommand
extends Object
implements OfficeFloorCommandFactory, OfficeFloorCommand

OfficeFloorCommand to open the OfficeConsole.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenOfficeConsoleCommand.OpenOfficeConsoleManagedProcess ManagedProcess to open the OfficeConsole.

Constructor Summary

Constructors

Constructor and Description
OpenOfficeConsoleCommand()

Method Summary

Modifier and Type	Method and Description
OfficeFloorCommand	createCommand() Creates the OfficeFloorCommand.
ManagedProcess	createManagedProcess(OfficeFloorCommandEnvironment environment) Creates the ManagedProcess to undertake the command.
String	getCommandName() Obtains the name of this OfficeFloorCommand.
String	getDescription() Obtains a description of this OfficeFloorCommand.
OfficeFloorCommandParameter[]	getParameters() Obtains the possible OfficeFloorCommandParameter instances for this OfficeFloorCommand.
void	initialiseEnvironment(OfficeFloorCommandContext context) Initialises this command's environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenOfficeConsoleCommand

public OpenOfficeConsoleCommand()

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: OfficeFloorCommandFactory

Obtains the name of this OfficeFloorCommand.

Specified by:

getCommandName in interface OfficeFloorCommandFactory

Returns:

Name of this OfficeFloorCommand.

createCommand

public OfficeFloorCommand createCommand()

Description copied from interface: OfficeFloorCommandFactory

Creates the OfficeFloorCommand.

Specified by:

createCommand in interface OfficeFloorCommandFactory

Returns:

OfficeFloorCommand.

getDescription

public String getDescription()

Description copied from interface: OfficeFloorCommand

Obtains a description of this OfficeFloorCommand.

Specified by:

getDescription in interface OfficeFloorCommand

Returns:

Description of this OfficeFloorCommand.

getParameters

public OfficeFloorCommandParameter[] getParameters()

Description copied from interface: OfficeFloorCommand

Obtains the possible OfficeFloorCommandParameter instances for this OfficeFloorCommand.

Specified by:

getParameters in interface OfficeFloorCommand

Returns:

Possible OfficeFloorCommandParameter instances.

initialiseEnvironment

public void initialiseEnvironment(OfficeFloorCommandContext context)
                           throws Exception

Description copied from interface: OfficeFloorCommand

Initialises this command's environment.

This allows to register additional class path entries for the ManagedProcess to be created by this command. It also allows the additional class path entries to be decorated by the OfficeFloorDecorator instances.

Specified by:

initialiseEnvironment in interface OfficeFloorCommand

Parameters:

context - OfficeFloorCommandContext.

Throws:

Exception - If fails to initialise this command.

createManagedProcess

public ManagedProcess createManagedProcess(OfficeFloorCommandEnvironment environment)
                                    throws Exception

Description copied from interface: OfficeFloorCommand

Creates the ManagedProcess to undertake the command.

Specified by:

createManagedProcess in interface OfficeFloorCommand

Parameters:

environment - OfficeFloorCommandEnvironment.

Returns:

ManagedProcess to undertake the command.

Throws:

Exception - If fails to create the ManagedProcess.