Class CliCommandGroupUsageGenerator<T>

    • Field Detail

      • hideGlobalOptions

        private final boolean hideGlobalOptions
    • Constructor Detail

      • CliCommandGroupUsageGenerator

        public CliCommandGroupUsageGenerator()
      • CliCommandGroupUsageGenerator

        public CliCommandGroupUsageGenerator​(boolean includeHidden)
      • CliCommandGroupUsageGenerator

        public CliCommandGroupUsageGenerator​(int columns)
      • CliCommandGroupUsageGenerator

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

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

      • outputOptions

        protected void outputOptions​(UsagePrinter out,
                                     GlobalMetadata<T> global,
                                     CommandGroupMetadata[] groups)
                              throws java.io.IOException
        Outputs a documentation section detailing the available options and their usages
        Parameters:
        out - Usage printer
        global - Global meta-data
        groups - Group(s) meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputSynopsis

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

        protected void outputDescription​(UsagePrinter out,
                                         GlobalMetadata<T> global,
                                         CommandGroupMetadata[] groups)
                                  throws java.io.IOException
        Outputs a description of the group
        Parameters:
        out - Usage printer
        global - Global meta-data
        groups - Groups meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output