Class MarkdownCommandUsageGenerator

    • Constructor Detail

      • 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,
                                             java.util.Comparator<? super OptionMetadata> optionComparator,
                                             boolean includeHidden)
    • Method Detail

      • usage

        public <T> void usage​(java.lang.String programName,
                              java.lang.String[] groupNames,
                              java.lang.String commandName,
                              CommandMetadata command,
                              ParserMetadata<T> parserConfig,
                              UsagePrinter out)
                       throws java.io.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:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputOptionsAndArguments

        protected <T> void outputOptionsAndArguments​(UsagePrinter out,
                                                     CommandMetadata command,
                                                     java.util.List<OptionMetadata> options,
                                                     ArgumentsMetadata arguments,
                                                     ParserMetadata<T> parserConfig)
                                              throws java.io.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:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputSynopsis

        protected java.util.List<OptionMetadata> outputSynopsis​(UsagePrinter out,
                                                                java.lang.String programName,
                                                                java.lang.String[] groupNames,
                                                                java.lang.String commandName,
                                                                CommandMetadata command)
                                                         throws java.io.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:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputDescription

        protected void outputDescription​(UsagePrinter out,
                                         java.lang.String programName,
                                         java.lang.String[] groupNames,
                                         java.lang.String commandName,
                                         CommandMetadata command)
                                  throws java.io.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:
        java.io.IOException - Thrown if there is a problem generating usage output