Class AbstractPrintedCommandGroupUsageGenerator<T>

    • Field Detail

      • columnSize

        private final int columnSize
    • Constructor Detail

      • AbstractPrintedCommandGroupUsageGenerator

        public AbstractPrintedCommandGroupUsageGenerator​(int columnSize,
                                                         java.util.Comparator<? super HelpHint> hintComparator,
                                                         java.util.Comparator<? super OptionMetadata> optionComparator,
                                                         java.util.Comparator<? super CommandMetadata> commandComparator,
                                                         boolean includeHidden)
    • Method Detail

      • usage

        protected abstract void usage​(GlobalMetadata<T> global,
                                      CommandGroupMetadata[] groups,
                                      UsagePrinter out)
                               throws java.io.IOException
        Generate the help and output is using the provided UsagePrinter
        Parameters:
        global - Global Metadata
        groups - Groups Metadata
        out - Usage printer to output with
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • createUsagePrinter

        protected UsagePrinter createUsagePrinter​(java.io.OutputStream out)
        Creates a usage printer for the given stream
        Parameters:
        out - Output stream
        Returns:
        Usage Printer
      • usage

        public void usage​(GlobalMetadata<T> global,
                          CommandGroupMetadata[] groups,
                          java.io.OutputStream out)
                   throws java.io.IOException
        Description copied from interface: CommandGroupUsageGenerator
        Generate the help and output it to the stream
        Parameters:
        global - Global metadata
        groups - Group path to the command
        out - Stream to output to
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output