org.nuxeo.shell.cmds

Class Help

java.lang.Object

org.nuxeo.shell.cmds.Help

All Implemented Interfaces:

Runnable

public class Help
extends Object
implements Runnable

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandType	cmd
protected File	export
protected CommandRegistry	ns
protected Shell	shell

Constructor Summary

Constructors

Constructor and Description
Help()

Method Summary

Modifier and Type	Method and Description
protected jline.ANSIBuffer	boldify(jline.ANSIBuffer buf, String text, boolean wiki)
void	exportCommands(Shell shell, File file)
void	exportRegistry(Shell shell, CommandRegistry reg, File file)
protected void	formatCommandForWiki()
protected jline.ANSIBuffer	getCommandHelp(CommandType cmd, boolean wiki)
protected jline.ANSIBuffer	header(jline.ANSIBuffer buf, String text, boolean wiki)
void	run()
void	showMainPage(ShellConsole console)
protected jline.ANSIBuffer	syntax(jline.ANSIBuffer buf, String syntax, boolean wiki)
protected void	writeCommand(CommandType cmd, StringBuilder sb)
protected void	writeRegistry(CommandRegistry reg, StringBuilder sb)

Methods inherited from class java.lang.Object

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

Field Detail

shell

protected Shell shell

cmd

protected CommandType cmd

export

protected File export

ns

protected CommandRegistry ns

Constructor Detail

Help

public Help()

Method Detail

run

public void run()

Specified by:

run in interface Runnable

showMainPage

public void showMainPage(ShellConsole console)

exportRegistry

public void exportRegistry(Shell shell,
                           CommandRegistry reg,
                           File file)
                    throws Exception

Throws:

Exception

exportCommands

public void exportCommands(Shell shell,
                           File file)
                    throws Exception

Throws:

Exception

writeRegistry

protected void writeRegistry(CommandRegistry reg,
                             StringBuilder sb)

writeCommand

protected void writeCommand(CommandType cmd,
                            StringBuilder sb)

getCommandHelp

protected jline.ANSIBuffer getCommandHelp(CommandType cmd,
                                          boolean wiki)

header

protected jline.ANSIBuffer header(jline.ANSIBuffer buf,
                                  String text,
                                  boolean wiki)

boldify

protected jline.ANSIBuffer boldify(jline.ANSIBuffer buf,
                                   String text,
                                   boolean wiki)

syntax

protected jline.ANSIBuffer syntax(jline.ANSIBuffer buf,
                                  String syntax,
                                  boolean wiki)

formatCommandForWiki

protected void formatCommandForWiki()