Class Help<T>

  • All Implemented Interfaces:
    java.lang.Runnable, java.util.concurrent.Callable<java.lang.Void>
    Direct Known Subclasses:
    CustomHelp

    @Command(name="help",
             description="Display help information")
    public class Help<T>
    extends java.lang.Object
    implements java.lang.Runnable, java.util.concurrent.Callable<java.lang.Void>
    • Constructor Summary

      Constructors 
      Constructor Description
      Help()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Void call()  
      static void help​(CommandMetadata command)
      Displays plain text format help for the given command to standard out
      static void help​(CommandMetadata command, boolean includeHidden)
      Displays plain text format help for the given command to standard out
      static void help​(CommandMetadata command, boolean includeHidden, java.io.OutputStream out)
      Displays plain text format help or the given command to the given output stream
      static void help​(CommandMetadata command, java.io.OutputStream out)
      Displays plain text format help or the given command to the given output stream
      static <T> void help​(GlobalMetadata<T> global, java.util.List<java.lang.String> commandNames)
      Displays plain text format program help to standard out
      static <T> void help​(GlobalMetadata<T> global, java.util.List<java.lang.String> commandNames, boolean includeHidden)
      Displays plain text format program help to standard out
      static <T> void help​(GlobalMetadata<T> global, java.util.List<java.lang.String> commandNames, boolean includeHidden, java.io.OutputStream out)
      Displays plain text format program help to the given output stream
      static <T> void help​(GlobalMetadata<T> global, java.util.List<java.lang.String> commandNames, java.io.OutputStream out)
      Displays plain text format program help to the given output stream
      void run()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Help

        public Help()
    • Method Detail

      • run

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

        public java.lang.Void call()
        Specified by:
        call in interface java.util.concurrent.Callable<T>
      • help

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

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

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

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

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

        public static <T> void help​(GlobalMetadata<T> global,
                                    java.util.List<java.lang.String> commandNames,
                                    boolean includeHidden)
                             throws java.io.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:
        java.io.IOException
      • help

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

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