Class MarkdownCommandUsageGenerator

All Implemented Interfaces:
CommandUsageGenerator

public class MarkdownCommandUsageGenerator extends AbstractPrintedCommandUsageGenerator
  • Field Details

  • Constructor Details

    • MarkdownCommandUsageGenerator

      public MarkdownCommandUsageGenerator()
    • MarkdownCommandUsageGenerator

      public MarkdownCommandUsageGenerator(boolean includeHidden)
    • MarkdownCommandUsageGenerator

      public MarkdownCommandUsageGenerator(int columns)
    • MarkdownCommandUsageGenerator

      public MarkdownCommandUsageGenerator(int columns, boolean includeHidden)
    • MarkdownCommandUsageGenerator

      public MarkdownCommandUsageGenerator(int columns, Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
  • Method Details

    • createHelper

      protected MarkdownUsageHelper createHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
    • usage

      public <T> void usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out) throws IOException
      Description copied from class: AbstractPrintedCommandUsageGenerator
      Generate the help and output it using the provided UsagePrinter
      Specified by:
      usage in class AbstractPrintedCommandUsageGenerator
      Type Parameters:
      T - Command type
      Parameters:
      programName - Program Name
      groupNames - Group Name(s)
      commandName - Command Name
      command - Command Metadata
      parserConfig - Parser configuration
      out - Usage printer to output with
      Throws:
      IOException - Thrown if there is a problem generating usage output
    • outputOptionsAndArguments

      protected <T> void outputOptionsAndArguments(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) throws IOException
      Outputs a documentation section detailing options and their usages
      Type Parameters:
      T - Command type
      Parameters:
      out - Usage printer
      command - Command meta-data
      options - Options meta-data
      arguments - Arguments meta-data
      parserConfig - Parser configuration
      Throws:
      IOException - Thrown if there is a problem generating usage output
    • outputSynopsis

      protected List<OptionMetadata> outputSynopsis(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) throws IOException
      Outputs a documentation section with a synopsis of command usage
      Parameters:
      out - Usage printer
      programName - Program name
      groupNames - Group name(s)
      commandName - Command name
      command - Command meta-data
      Returns:
      Collection of all options (Global, Group and Command)
      Throws:
      IOException - Thrown if there is a problem generating usage output
    • outputDescription

      protected void outputDescription(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) throws IOException
      Outputs a documentation section describing the command
      Parameters:
      out - Usage printer
      programName - Program name
      groupNames - Group name(s)
      commandName - Command name
      command - Command meta-data
      Throws:
      IOException - Thrown if there is a problem generating usage output