Package org.apache.karaf.tooling.commands

Class DocBookCommandHelpPrinter

java.lang.Object

org.apache.karaf.tooling.commands.AbstractCommandHelpPrinter

org.apache.karaf.tooling.commands.DocBookCommandHelpPrinter

All Implemented Interfaces:

CommandHelpPrinter

public class DocBookCommandHelpPrinter
extends AbstractCommandHelpPrinter

Prints documentation in docbook syntax

Constructor Summary

Constructors

Constructor	Description
DocBookCommandHelpPrinter()

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 writer)	Print the overview of all given commands to the out stream.

Methods inherited from class org.apache.karaf.tooling.commands.AbstractCommandHelpPrinter

getDefaultValue, getDefaultValueString, replaceDefaultArgument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocBookCommandHelpPrinter

public DocBookCommandHelpPrinter()

Method Detail

printHelp

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

Description copied from interface: CommandHelpPrinter

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

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

Description copied from interface: CommandHelpPrinter

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

Parameters:

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

writer - The stream where to write the overview.