Interface CommandGroupUsageGenerator<T>

All Known Implementing Classes:
AbstractCommandGroupUsageGenerator, AbstractPrintedCommandGroupUsageGenerator, CliCommandGroupUsageGenerator

public interface CommandGroupUsageGenerator<T>
Interface implemented by classes that can generate usage documentation for a command group
  • Method Details

    • usage

      void usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups) throws IOException
      Generate the help and output it on standard out
      Parameters:
      global - Global Metadata
      groups - Group path to the command
      Throws:
      IOException - Thrown if there is a problem generating usage output
    • usage

      void usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, OutputStream output) throws IOException
      Generate the help and output it to the stream
      Parameters:
      global - Global metadata
      groups - Group path to the command
      output - Stream to output to
      Throws:
      IOException - Thrown if there is a problem generating usage output