CAShellCmdHelp

java.lang.Object

com.io7m.cardant.shell.internal.CAShellCmdAbstract

com.io7m.cardant.shell.internal.CAShellCmdHelp

All Implemented Interfaces:: CAShellCmdType, com.io7m.quarrel.core.QCommandOrGroupType, com.io7m.quarrel.core.QCommandType

public final class CAShellCmdHelp extends CAShellCmdAbstract

"help"

Constructor Summary

Constructors

Constructor

Description

CAShellCmdHelp(com.io7m.repetoir.core.RPServiceDirectoryType inServices)

Construct a command.
Method Summary

Modifier and Type

Method

Description

org.jline.reader.Completer

completer()

com.io7m.quarrel.core.QCommandStatus

onExecute(com.io7m.quarrel.core.QCommandContextType context)

List<com.io7m.quarrel.core.QParameterNamedType<?>>

onListNamedParameters()

com.io7m.quarrel.core.QParametersPositionalType

onListPositionalParameters()

Methods inherited from class com.io7m.cardant.shell.internal.CAShellCmdAbstract
client, commandTimeout, formatter, loginTimeout, loginTracker, metadata, options, preferences, setCommandTimeoutRecent, setLoginTimeoutRecent, strings, terminal, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.quarrel.core.QCommandOrGroupType
isHidden

Constructor Details
- CAShellCmdHelp
  
  public CAShellCmdHelp(com.io7m.repetoir.core.RPServiceDirectoryType inServices)
  
  Construct a command.
  
  Parameters:
  
  inServices - The context
Method Details
- completer
  
  public org.jline.reader.Completer completer()
  
  Returns:
  
  A shell command completer for the command
- onListNamedParameters
  
  public List<com.io7m.quarrel.core.QParameterNamedType<?>> onListNamedParameters()
- onListPositionalParameters
  
  public com.io7m.quarrel.core.QParametersPositionalType onListPositionalParameters()
- onExecute
  
  public com.io7m.quarrel.core.QCommandStatus onExecute(com.io7m.quarrel.core.QCommandContextType context) throws com.io7m.quarrel.core.QException
  
  Throws:
  
  com.io7m.quarrel.core.QException