Interface Help.HelpFormatter

All Known Implementing Classes:
Help.CliHelpFormatter, Help.ManPageFormatter
Enclosing class:
Help
private static interface Help.HelpFormatter

  • Method Details

    • printTitle

      void printTitle()

    • printName

      void printName()

    • printUsageHeading

      void printUsageHeading()

    • printUsage

      default void printUsage()
      Prints each launch option prepended with the common
      invalid reference 
      #launcher()
      String. Man page formatting doesn't mind the indentation so this is common for both formatters.

    • printOptionsHeading

      void printOptionsHeading()

    • printMainOptionsSubheading

      void printMainOptionsSubheading()

    • printSavingOptionsSubheading

      void printSavingOptionsSubheading()

    • printOptions

      default void printOptions()

    • printOptions

      void printOptions(Map<String,String> map)

    • optionize

      String optionize(String[] options)
      Joins options together with a pipe and surrounds them in parentheses.
      Parameters:
      options - String array containing the individual options
      Returns:
      String in the format of "(opt1|opt2|...)"

    • indent

      default String indent(int depth)

    • launchOptions

      default String[] launchOptions()

    • launcher

      String launcher(boolean verbose)

    • savingModifiers

      String savingModifiers()

    • printNotesHeading

      void printNotesHeading()

    • printNotes

      void printNotes()