Interface CommandUsageGenerator

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <T> void usage​(CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)
      Generates the help output to the provided output stream
      <T> void usage​(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig)
      Generate the help and output it on standard out
      <T> void usage​(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)
      Generate the help and output it to the stream
    • Method Detail

      • usage

        <T> void usage​(CommandMetadata command,
                       ParserMetadata<T> parserConfig,
                       java.io.OutputStream output)
                throws java.io.IOException
        Generates the help output to the provided output stream
        Parameters:
        command - Command Metadata
        parserConfig - Parser configuration
        output - Output Stream
        Throws:
        java.io.IOException
      • usage

        <T> void usage​(java.lang.String programName,
                       java.lang.String[] groupNames,
                       java.lang.String commandName,
                       CommandMetadata command,
                       ParserMetadata<T> parserConfig)
                throws java.io.IOException
        Generate the help and output it on standard out
        Type Parameters:
        T - Command type
        Parameters:
        programName - Program Name
        groupNames - Group Name(s)
        commandName - Command Name
        command - Command Metadata
        parserConfig - Parser configuration, if null is passed then the parser configuration is automatically determined based on the command class for which we are producing help
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • usage

        <T> void usage​(java.lang.String programName,
                       java.lang.String[] groupNames,
                       java.lang.String commandName,
                       CommandMetadata command,
                       ParserMetadata<T> parserConfig,
                       java.io.OutputStream output)
                throws java.io.IOException
        Generate the help and output it to the stream
        Type Parameters:
        T - Command type
        Parameters:
        programName - Program Name
        groupNames - Group Name(s)
        commandName - Command Name
        command - Command Metadata
        parserConfig - Parser Configuration, if null is passed then the parser configuration is automatically determined based on the command class for which we are producing help
        output - Stream to output to
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output