io.sarl.apputils.bootiqueapp.mdhelp
Class GenerateMarkdownHelpCommand
All Superinterfaces:
io.bootique.command.Command
class GenerateMarkdownHelpCommand
extends java.lang.Object
Command for displaying the help on the standard output using a Markdown format.
Maven Group Identifier:
io.sarl.apputils
Maven Artifact Identifier:
bootiqueapp
Since:
0.12
Constructor Summary
Constructor and description
new(Injector)
Constructor.
new(Injector,Class<T>,String)
Constructor.
Action Summary
Modifier and type Action and description
static java.util.List<E> getOptions(Injector)
Replies the list of command-line options that are defined inside the runtime injector.
static java.util.List<E> getOptionsAsStrings(Injector,boolean)
Replies the options of the program in the form of a matrix of strings of characters.
io.bootique.command.CommandOutcome run(Cli)
Constructor Details
new(Injector) 
new(Injector)
Constructor.
Parameters:
injector - the injector to be used.
new(Injector,Class<T>,String) 
protected new(Injector,Class<T>,String)
Constructor.
Parameters:
injector - the injector to be used.
commandType - the type of the command.
description - the description of the command.
Action Details
getOptions(Injector) 
def getOptions(Injector) : java.util.List<E>
Replies the list of command-line options that are defined inside the runtime injector.
Parameters:
runtime - the runtime injector.
Returns:
the options.
getOptionsAsStrings(Injector,boolean) 
def getOptionsAsStrings(Injector,boolean) : java.util.List<E>
Replies the options of the program in the form of a matrix of strings of characters. The replied value is a table with 2 columns: the options' names, and the options' descriptions. Each line of the table is a different option.
Parameters:
runtime - the runtime injector.
replacePipes - indicates if the pipe character must be replaced by its HTML equivalent character.
Returns:
the options of the program as a matrix of strings.
run(Cli) 
def run(Cli) : io.bootique.command.CommandOutcome