Package org.apache.karaf.tooling.commands

Interface CommandHelpPrinter

All Known Implementing Classes:

AbstractCommandHelpPrinter, AsciiDoctorCommandHelpPrinter, DocBookCommandHelpPrinter, UserConfCommandHelpPrinter

public interface CommandHelpPrinter

Method Summary

Modifier and Type	Method	Description
void	printHelp(org.apache.karaf.shell.api.action.Action action, PrintStream out, boolean includeHelpOption)	Print help for a single action to the out stream.
void	printOverview(Map<String,Set<String>> commands, PrintStream out)	Print the overview of all given commands to the out stream.

Method Detail

printHelp

void printHelp(org.apache.karaf.shell.api.action.Action action,
               PrintStream out,
               boolean includeHelpOption)

Print help for a single action to the out stream.

Parameters:

action - The command Action.

out - The stream where to print the help.

includeHelpOption - True to include the help option in the doc, false else.

printOverview

void printOverview(Map<String,Set<String>> commands,
                   PrintStream out)

Print the overview of all given commands to the out stream.

Parameters:

commands - The Map of commands to consider in the overview.

out - The stream where to write the overview.