Modifier and Type | Field and Description |
---|---|
List<String> |
command |
GlobalMetadata<T> |
global |
boolean |
includeHidden |
Constructor and Description |
---|
Help() |
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() |
@Inject public GlobalMetadata<T> global
@Arguments public List<String> command
@Option(name="--include-hidden", description="When set the help output will include hidden commands and options", hidden=true) public boolean includeHidden
public static void help(CommandMetadata command) throws IOException
command
- CommandIOException
public static void help(CommandMetadata command, boolean includeHidden) throws IOException
command
- CommandIOException
public static void help(CommandMetadata command, OutputStream out) throws IOException
command
- Commandout
- Output streamIOException
public static void help(CommandMetadata command, boolean includeHidden, OutputStream out) throws IOException
command
- Commandout
- Output streamIOException
public static <T> void help(GlobalMetadata<T> global, List<String> commandNames) throws IOException
global
- Program metadatacommandNames
- Command NamesIOException
public static <T> void help(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden) throws IOException
global
- Program metadatacommandNames
- Command NamesincludeHidden
- Whether to include hidden commands and options in the outputIOException
public static <T> void help(GlobalMetadata<T> global, List<String> commandNames, OutputStream out) throws IOException
global
- Program meta-datacommandNames
- Command Namesout
- Output StreamIOException
public static <T> void help(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden, OutputStream out) throws IOException
global
- Program meta-datacommandNames
- Command Namesout
- Output StreamIOException
Copyright © 2012–2017. All rights reserved.