net.officefloor.building.console

Class HelpManagedProcess

java.lang.Object

net.officefloor.building.console.HelpManagedProcess

All Implemented Interfaces:

Serializable, ManagedProcess

public final class HelpManagedProcess
extends Object
implements ManagedProcess

Help ManagedProcess.

Author:

Daniel Sagenschneider

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HelpManagedProcess()

Method Summary

Modifier and Type	Method and Description
void	init(ManagedProcessContext context) Initialises this ManagedProcess.
void	main() Runs the functionality.
void	writeHelp(PrintStream out, String scriptName, OfficeFloorCommandFactory[] commandFactories) Write out the help.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpManagedProcess

public HelpManagedProcess()

Method Detail

writeHelp

public void writeHelp(PrintStream out,
                      String scriptName,
                      OfficeFloorCommandFactory[] commandFactories)

Write out the help.

Parameters:

out - Out stream to write help.

scriptName - Name of the script invoking the OfficeFloorCommand. null indicates from within OfficeFloorConsole.

commandFactories - OfficeFloorCommandFactory instances for help content to be written.

init

public void init(ManagedProcessContext context)
          throws Throwable

Description copied from interface: ManagedProcess

Initialises this ManagedProcess.

All MBean instances registered before this method returns will be made available to the ProcessManager before it is returned on starting the Process.

Specified by:

init in interface ManagedProcess

Parameters:

context - ManagedProcessContext.

Throws:

Throwable - If fails to initialise.

main

public void main()
          throws Throwable

Description copied from interface: ManagedProcess

Runs the functionality.

This should be a blocking call. Once this method returns the process is considered finished.

Specified by:

main in interface ManagedProcess

Throws:

Throwable - If fails.