com.github.rvesse.airline.help

Class Help<T>

java.lang.Object

com.github.rvesse.airline.help.Help<T>

All Implemented Interfaces:

Runnable, Callable<Void>

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

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	command
GlobalMetadata<T>	global
boolean	includeHidden

Constructor Summary

Constructors

Constructor and Description
Help()

Method Summary

Modifier and Type	Method and Description
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, OutputStream out) Displays plain text format help or the given command to the given output stream
static void	help(CommandMetadata command, OutputStream out) Displays plain text format help or the given command to the given output stream
static <T> void	help(GlobalMetadata<T> global, List<String> commandNames) Displays plain text format program help to standard out
static <T> void	help(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden) Displays plain text format program help to standard out
static <T> void	help(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden, OutputStream out) Displays plain text format program help to the given output stream
static <T> void	help(GlobalMetadata<T> global, List<String> commandNames, 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

Field Detail

global

@Inject
public GlobalMetadata<T> global

command

@Arguments
public List<String> command

includeHidden

@Option(name="--include-hidden",
        description="When set the help output will include hidden commands and options",
        hidden=true)
public boolean includeHidden

Constructor Detail

Help

public Help()

Method Detail

run

public void run()

Specified by:

run in interface Runnable

call

public Void call()

Specified by:

call in interface Callable<Void>

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