io.sarl.apputils.bootiqueapp.mdconfig
Class GenerateMarkdownConfigCommand
All Superinterfaces:
io.bootique.command.Command
class GenerateMarkdownConfigCommand
extends java.lang.Object
Command for displaying the help for configuration parameters 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(ModulesMetadata)
Constructor.
new(ModulesMetadata,Class<T>,String)
Constructor.
Action Summary
Modifier and type Action and description
static java.util.List<E> getConfigurationParameters(ModulesMetadata,String)
Replies the list of configuration parameters.
static java.util.List<E> getConfigurationParametersAsStrings(ModulesMetadata,String,boolean,boolean)
Replies the list of configuration parameters.
io.bootique.command.CommandOutcome run(Cli)
Constructor Details
new(ModulesMetadata) 
new(ModulesMetadata)
Constructor.
Parameters:
modulesMetadata - the description of the modules.
new(ModulesMetadata,Class<T>,String) 
protected new(ModulesMetadata,Class<T>,String)
Constructor.
Parameters:
modulesMetadata - the description of the modules.
commandType - the type of the command.
description - the description of the command.
Action Details
getConfigurationParameters(ModulesMetadata,String) 
def getConfigurationParameters(ModulesMetadata,String) : java.util.List<E>
Replies the list of configuration parameters.
Parameters:
modulesMetadata - the description of the modules.
selectedRoot - the name of the configuration root that must be selected and for which the configuration parameters must be replied. If the name is empty or null, all the roots are selected by default.
Returns:
the configuration parameters.
getConfigurationParametersAsStrings(ModulesMetadata,String,boolean,boolean) 
def getConfigurationParametersAsStrings(ModulesMetadata,String,boolean,boolean) : java.util.List<E>
Replies the list of configuration parameters.
Parameters:
modulesMetadata - the description of the modules.
selectedRoot - the name of the configuration root that must be selected and for which the configuration parameters must be replied. If the name is empty or null, all the roots are selected by default.
replacePipes - indicates if the pipe character must be replaced by its HTML equivalent character.
addLineIfNoData - indicates if a line should be added if there is no data from the modules.
Returns:
the configuration parameters.
run(Cli) 
def run(Cli) : io.bootique.command.CommandOutcome