java.lang.Object
com.github.rvesse.airline.help.Help<T>
- Direct Known Subclasses:
CustomHelp
-
Field Summary
FieldsModifier and TypeFieldDescriptionboolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncall()
static void
help
(CommandMetadata command) Displays plain text format help for the given command to standard outstatic void
help
(CommandMetadata command, boolean includeHidden) Displays plain text format help for the given command to standard outstatic void
help
(CommandMetadata command, boolean includeHidden, OutputStream out) Displays plain text format help or the given command to the given output streamstatic void
help
(CommandMetadata command, OutputStream out) Displays plain text format help or the given command to the given output streamstatic <T> void
help
(GlobalMetadata<T> global, List<String> commandNames) Displays plain text format program help to standard outstatic <T> void
help
(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden) Displays plain text format program help to standard outstatic <T> void
help
(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden, OutputStream out) Displays plain text format program help to the given output streamstatic <T> void
help
(GlobalMetadata<T> global, List<String> commandNames, OutputStream out) Displays plain text format program help to the given output streamvoid
run()
-
Field Details
-
global
-
command
-
includeHidden
@Option(name="--include-hidden", description="When set the help output will include hidden commands and options", hidden=true) public boolean includeHidden
-
-
Constructor Details
-
Help
public Help()
-
-
Method Details
-
run
public void run() -
call
-
help
Displays plain text format help for the given command to standard out- Parameters:
command
- Command- Throws:
IOException
-
help
Displays plain text format help for the given command to standard out- Parameters:
command
- Command- Throws:
IOException
-
help
Displays plain text format help or the given command to the given output stream- Parameters:
command
- Commandout
- 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
- Commandout
- Output stream- Throws:
IOException
-
help
Displays plain text format program help to standard out- Parameters:
global
- Program metadatacommandNames
- 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 metadatacommandNames
- Command NamesincludeHidden
- 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-datacommandNames
- Command Namesout
- 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-datacommandNames
- Command Namesout
- Output Stream- Throws:
IOException
-