Package za.co.wethinkcode.robots.cli.help

Class ServerLaunchHelpProvider

java.lang.Object

za.co.wethinkcode.robots.cli.help.ServerLaunchHelpProvider

All Implemented Interfaces:

LaunchHelpProvider

public class ServerLaunchHelpProvider
extends Object
implements LaunchHelpProvider

Renders launch help for the Robot World server, sourcing the actual command from the server Makefile target where possible.

Constructor Summary

Constructors

Constructor	Description
ServerLaunchHelpProvider()
ServerLaunchHelpProvider(MakefileRecipeReader recipeReader)

Method Summary

Modifier and Type	Method	Description
String	render()
HelpTopic	topic()

Methods inherited from class java.lang.Object

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

Constructor Details

ServerLaunchHelpProvider

public ServerLaunchHelpProvider()

ServerLaunchHelpProvider

public ServerLaunchHelpProvider(MakefileRecipeReader recipeReader)

Method Details

topic

public HelpTopic topic()

Specified by:

topic in interface LaunchHelpProvider

Returns:

the topic this provider renders help for

render

public String render()

Specified by:

render in interface LaunchHelpProvider

Returns:

the fully formatted help text for this topic