Class CliGlobalUsageGenerator<T>

    • Constructor Detail

      • CliGlobalUsageGenerator

        public CliGlobalUsageGenerator()
      • CliGlobalUsageGenerator

        public CliGlobalUsageGenerator​(boolean includeHidden)
      • CliGlobalUsageGenerator

        public CliGlobalUsageGenerator​(int columns)
      • CliGlobalUsageGenerator

        public CliGlobalUsageGenerator​(int columns,
                                       boolean includeHidden)
      • CliGlobalUsageGenerator

        public CliGlobalUsageGenerator​(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)
      • outputCommandList

        protected void outputCommandList​(UsagePrinter out,
                                         GlobalMetadata<T> global)
                                  throws java.io.IOException
        Outputs a documentation section listing the commands
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputSynopsis

        protected void outputSynopsis​(UsagePrinter out,
                                      GlobalMetadata<T> global)
                               throws java.io.IOException
        Outputs a documentation section with a synopsis of CLI usage
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputDescription

        protected void outputDescription​(UsagePrinter out,
                                         GlobalMetadata<T> global)
                                  throws java.io.IOException
        Outputs a documentation section with a description of the CLI
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputCommandDescription

        protected void outputCommandDescription​(UsagePrinter out,
                                                CommandGroupMetadata group,
                                                CommandMetadata command)
                                         throws java.io.IOException
        Outputs the description for a command
        Parameters:
        out - Usage printer
        group - Group meta-data
        command - Command meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output