org.apache.karaf.tooling.cmdhelp
Class CmdHelpMojo.HelpPrinter

java.lang.Object
  org.apache.felix.gogo.commands.basic.AbstractCommand
      org.apache.karaf.shell.console.commands.BlueprintCommand
          org.apache.karaf.tooling.cmdhelp.CmdHelpMojo.HelpPrinter

All Implemented Interfaces:

org.apache.felix.service.command.Function, CompletableFunction

Enclosing class:

CmdHelpMojo

public static class CmdHelpMojo.HelpPrinter
extends BlueprintCommand

Nested Class Summary

protected class	CmdHelpMojo.HelpPrinter.ConfPreparator
protected class	CmdHelpMojo.HelpPrinter.DocbxPreparator
protected static class	CmdHelpMojo.HelpPrinter.DummyCommandSession

Nested classes/interfaces inherited from class org.apache.karaf.shell.console.commands.BlueprintCommand

BlueprintCommand.BlueprintActionPreparator

Field Summary

Fields inherited from class org.apache.karaf.shell.console.commands.BlueprintCommand

actionId, blueprintContainer, blueprintConverter, completers, optionalCompleters

Constructor Summary

CmdHelpMojo.HelpPrinter(Class<Action> actionClass)

Method Summary

String

printHelp(String format, boolean includeHelpOption)

Methods inherited from class org.apache.karaf.shell.console.commands.BlueprintCommand

createNewAction, getCompleters, getOptionalCompleters, getPreparator, setActionId, setBlueprintContainer, setBlueprintConverter, setCompleters, setOptionalCompleters

Methods inherited from class org.apache.felix.gogo.commands.basic.AbstractCommand

execute, getActionClass, releaseAction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.felix.service.command.Function

execute

Constructor Detail

CmdHelpMojo.HelpPrinter

public CmdHelpMojo.HelpPrinter(Class<Action> actionClass)

Method Detail

printHelp

public String printHelp(String format,
                        boolean includeHelpOption)
                 throws Exception

Throws:

Exception