QCommandHelp

java.lang.Object

com.io7m.quarrel.core.internal.QCommandHelp

All Implemented Interfaces:: QCommandOrGroupType, QCommandType

public final class QCommandHelp extends Object implements QCommandType

The help command.

Constructor Summary

Constructors

Constructor

Description

QCommandHelp(String inApplicationName, Map<String, QCommandOrGroupType> inCommandTree)

The help command.
Method Summary

Modifier and Type

Method

Description

QCommandMetadata

metadata()

QCommandStatus

onExecute(QCommandContextType context)

Execute the command.

List<QParameterNamedType<?>>

onListNamedParameters()

QParametersPositionalType

onListPositionalParameters()

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface QCommandOrGroupType
isHidden

Constructor Details
- QCommandHelp
  
  public QCommandHelp(String inApplicationName, Map<String, QCommandOrGroupType> inCommandTree)
  
  The help command.
  
  Parameters:
  
  inApplicationName - The application name
  
  inCommandTree - The tree of commands
Method Details
- onListNamedParameters
  
  public List<QParameterNamedType<?>> onListNamedParameters()
  
  Specified by:
  
  onListNamedParameters in interface QCommandType
  
  Returns:
  
  The named parameters for the command
- onListPositionalParameters
  
  public QParametersPositionalType onListPositionalParameters()
  
  Specified by:
  
  onListPositionalParameters in interface QCommandType
  
  Returns:
  
  The positional parameters for the command
- onExecute
  
  public QCommandStatus onExecute(QCommandContextType context) throws Exception
  
  Description copied from interface: QCommandType
  
  Execute the command.
  
  Specified by:
  
  onExecute in interface QCommandType
  
  Parameters:
  
  context - The command context
  
  Returns:
  
  The result of execution
  
  Throws:
  
  Exception - On errors
- metadata
  
  public QCommandMetadata metadata()
  
  Specified by:
  
  metadata in interface QCommandOrGroupType
  
  Returns:
  
  The descriptive metadata for the command/group