org.sonatype.gshell.commands.standard
Class HelpCommand

java.lang.Object
  org.sonatype.gshell.command.support.CommandActionSupport
      org.sonatype.gshell.commands.standard.HelpCommand

All Implemented Interfaces:

Cloneable, CommandAction, NameAware

@Command(name="help")
public class HelpCommand
extends CommandActionSupport

Display help pages.

Since:

2.5

Author:

Jason Dillon

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonatype.gshell.command.CommandAction

CommandAction.Result

Field Summary

Fields inherited from class org.sonatype.gshell.command.support.CommandActionSupport

log

Constructor Summary

HelpCommand(HelpPageManager helpPages)

Method Summary

Object	execute(CommandContext context) Execute the command action.
HelpCommand	installCompleters(jline.console.completer.Completer c1, jline.console.completer.Completer c2, jline.console.completer.Completer c3)

Methods inherited from class org.sonatype.gshell.command.support.CommandActionSupport

clone, createMessages, getCompleters, getMessages, getName, getSimpleName, setCompleters, setCompleters, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

@Inject
public HelpCommand(HelpPageManager helpPages)

Method Detail

installCompleters

@Inject
public HelpCommand installCompleters(jline.console.completer.Completer c1,
                                            jline.console.completer.Completer c2,
                                            jline.console.completer.Completer c3)

execute

public Object execute(CommandContext context)
               throws Exception

Description copied from interface: CommandAction

Execute the command action.

Parameters:

context - The execution context of the command.

Returns:

The result of the command execution.

Throws:

Exception - Command execution failed.