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

Interface LaunchHelpProvider

All Known Implementing Classes:
ClientLaunchHelpProvider, ServerLaunchHelpProvider
public interface LaunchHelpProvider
A single topic's contribution to the launch-help CLI command.

Implementations are pure: render() returns formatted text and causes no side effects. Printing is the caller's responsibility.

  • Method Summary

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

  • Method Details

    • topic

      HelpTopic topic()
      Returns:
      the topic this provider renders help for

    • render

      String render()
      Returns:
      the fully formatted help text for this topic