java.lang.Object
com.github.rvesse.airline.help.Help<T>
All Implemented Interfaces:
Runnable, Callable<Void>
Direct Known Subclasses:
CustomHelp

@Command(name="help", description="Display help information") public class Help<T> extends Object implements Runnable, Callable<Void>
  • Field Details

  • Constructor Details

    • Help

      public Help()
  • Method Details

    • run

      public void run()
      Specified by:
      run in interface Runnable
    • call

      public Void call()
      Specified by:
      call in interface Callable<T>
    • help

      public static void help(CommandMetadata command) throws IOException
      Displays plain text format help for the given command to standard out
      Parameters:
      command - Command
      Throws:
      IOException
    • help

      public static void help(CommandMetadata command, boolean includeHidden) throws IOException
      Displays plain text format help for the given command to standard out
      Parameters:
      command - Command
      Throws:
      IOException
    • help

      public static void help(CommandMetadata command, OutputStream out) throws IOException
      Displays plain text format help or the given command to the given output stream
      Parameters:
      command - Command
      out - Output stream
      Throws:
      IOException
    • help

      public static void help(CommandMetadata command, boolean includeHidden, OutputStream out) throws IOException
      Displays plain text format help or the given command to the given output stream
      Parameters:
      command - Command
      out - Output stream
      Throws:
      IOException
    • help

      public static <T> void help(GlobalMetadata<T> global, List<String> commandNames) throws IOException
      Displays plain text format program help to standard out
      Parameters:
      global - Program metadata
      commandNames - Command Names
      Throws:
      IOException
    • help

      public static <T> void help(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden) throws IOException
      Displays plain text format program help to standard out
      Parameters:
      global - Program metadata
      commandNames - Command Names
      includeHidden - Whether to include hidden commands and options in the output
      Throws:
      IOException
    • help

      public static <T> void help(GlobalMetadata<T> global, List<String> commandNames, OutputStream out) throws IOException
      Displays plain text format program help to the given output stream
      Parameters:
      global - Program meta-data
      commandNames - Command Names
      out - Output Stream
      Throws:
      IOException
    • help

      public static <T> void help(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden, OutputStream out) throws IOException
      Displays plain text format program help to the given output stream
      Parameters:
      global - Program meta-data
      commandNames - Command Names
      out - Output Stream
      Throws:
      IOException