Class Help


  • public class Help
    extends java.lang.Object
    The command line help text generator.
    • Constructor Summary

      Constructors 
      Constructor Description
      Help​(java.lang.String executionCommand, CommandLine commandLine)
      Consturcts the help generator.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String generate()
      Generates the help text.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Help

        public Help​(java.lang.String executionCommand,
                    CommandLine commandLine)
        Consturcts the help generator.
        Parameters:
        executionCommand - the command to execute this application
        commandLine - the command line argument parser object
    • Method Detail

      • generate

        public java.lang.String generate()
        Generates the help text.
        Returns:
        the help text