Class CliGlobalUsageSummaryGenerator<T>

    • Constructor Detail

      • CliGlobalUsageSummaryGenerator

        public CliGlobalUsageSummaryGenerator()
      • CliGlobalUsageSummaryGenerator

        public CliGlobalUsageSummaryGenerator​(boolean includeHidden)
      • CliGlobalUsageSummaryGenerator

        public CliGlobalUsageSummaryGenerator​(int columnSize)
      • CliGlobalUsageSummaryGenerator

        public CliGlobalUsageSummaryGenerator​(int columnSize,
                                              boolean includeHidden)
      • CliGlobalUsageSummaryGenerator

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

      • createHelper

        protected CliUsageHelper createHelper​(java.util.Comparator<? super OptionMetadata> optionComparator,
                                              boolean includeHidden)
      • outputFooter

        protected void outputFooter​(UsagePrinter out,
                                    GlobalMetadata<T> global)
                             throws java.io.IOException
        Outputs a documentation section detailing how to get more help
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException
      • outputCommandList

        protected void outputCommandList​(UsagePrinter out,
                                         GlobalMetadata<T> global)
                                  throws java.io.IOException
        Outputs a documentation section listing the common commands and groups
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException
      • outputSynopsis

        protected void outputSynopsis​(UsagePrinter out,
                                      GlobalMetadata<T> global)
                               throws java.io.IOException
        Outputs a documentation section with a brief synopsis of usage
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException