ExDog

java.lang.Object

com.io7m.quarrel.example.ExDog

All Implemented Interfaces:: QCommandOrGroupType, QCommandType

public final class ExDog extends Object implements QCommandType

An example command.

Constructor Summary

Constructors

Constructor

Description

ExDog()

An example 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
- ExDog
  
  public ExDog()
  
  An example command.
Method Details
- metadata
  
  public QCommandMetadata metadata()
  
  Specified by:
  
  metadata in interface QCommandOrGroupType
  
  Returns:
  
  The descriptive metadata for the command/group
- 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