Uses of Class
picocli.CommandLine.Help
-
Uses of CommandLine.Help in picocli
Fields in picocli with type parameters of type CommandLine.HelpModifier and TypeFieldDescriptionprivate final Map
<String, CommandLine.Help> CommandLine.Help.allCommands
private final Map
<String, CommandLine.Help> CommandLine.Help.visibleCommands
Methods in picocli that return CommandLine.HelpModifier and TypeMethodDescriptionCommandLine.Help.addAllSubcommands
(Map<String, CommandLine> subcommands) Registers all specified subcommands with this Help.CommandLine.Help.addSubcommand
(String commandName, Object command) Deprecated.CommandLine.DefaultHelpFactory.create
(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme) CommandLine.IHelpFactory.create
(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme) Returns aHelp
instance to assist in rendering the usage help messageCommandLine.getHelp()
Returns a newHelp
object created by theIHelpFactory
with theCommandSpec
andColorScheme
of this command.(package private) CommandLine.Help
CommandLine.Help.withCommandNames
(List<String> aliases) Methods in picocli that return types with arguments of type CommandLine.HelpModifier and TypeMethodDescriptionCommandLine.Help.allSubcommands()
Returns the map of all subcommandHelp
instances (including hidden commands) for this command Help.CommandLine.Help.subcommands()
Returns the map of non-hidden subcommandHelp
instances for this command Help.Methods in picocli with parameters of type CommandLine.HelpModifier and TypeMethodDescriptionCommandLine.IHelpSectionRenderer.render
(CommandLine.Help help) Renders a section of the usage help, like header heading, header, synopsis heading, synopsis, description heading, description, etc.private StringBuilder
CommandLine.usage
(StringBuilder sb, CommandLine.Help help) Method parameters in picocli with type arguments of type CommandLine.HelpModifier and TypeMethodDescriptionCommandLine.Help.commandList
(Map<String, CommandLine.Help> subcommands) Returns a 2-column list with the command names and first line of their header or (if absent) description of the specified command map.
addAllSubcommands(Map)
instead