org.neovera.jdiablo.environment
Class Help

java.lang.Object
  org.neovera.jdiablo.AbstractEnvironment
      org.neovera.jdiablo.environment.Help

All Implemented Interfaces:

Environment

public class Help
extends AbstractEnvironment

Add this environment to enable a -h (or --help) option that what options are available and the description of the options.

Constructor Summary

Help()

Method Summary

HelpProvider	getHelpProvider()
boolean	isHelp()
void	setHelp(boolean help)
void	setHelpProvider(HelpProvider helpProvider)
boolean	start() Start the environment.
void	stop() Stop the environment.

Methods inherited from class org.neovera.jdiablo.AbstractEnvironment

initialize, initialize, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

Help

public Help()

Method Detail

isHelp

public boolean isHelp()

setHelp

public void setHelp(boolean help)

getHelpProvider

public HelpProvider getHelpProvider()

setHelpProvider

public void setHelpProvider(HelpProvider helpProvider)

start

public boolean start()

Description copied from interface: Environment

Start the environment. Any exception thrown will cause target execution to abort and stop to be called.

Specified by:

start in interface Environment

Overrides:

start in class AbstractEnvironment

Returns:

true to continue to next environment, false to stop all environments and abort launch.

stop

public void stop()

Description copied from interface: Environment

Stop the environment.

Specified by:

stop in interface Environment

Overrides:

stop in class AbstractEnvironment