org.apache.karaf.tooling.commands

Interface CommandHelpPrinter

All Known Implementing Classes:

AbstractCommandHelpPrinter, DocBookCommandHelpPrinter, UserConfCommandHelpPrinter

public interface CommandHelpPrinter

Method Summary

Methods

Modifier and Type	Method and 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 -

out - stream to write to

includeHelpOption - include the help option in the doc

printOverview

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

Print the overview of all given commands to the out stream

Parameters:

commands -

out -