QCommandXS

java.lang.Object

com.io7m.quarrel.ext.xstructural.QCommandXS

All Implemented Interfaces:: QCommandOrGroupType, QCommandType

public final class QCommandXS extends Object implements QCommandType

A command that produces an xstructural documentation template.

Constructor Summary

Constructors

Constructor

Description

QCommandXS(String inName, boolean inHidden)

A command that produces an xstructural documentation template.
Method Summary

Modifier and Type

Method

Description

boolean

isHidden()

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

Constructor Details
- QCommandXS
  
  public QCommandXS(String inName, boolean inHidden)
  
  A command that produces an xstructural documentation template.
  
  Parameters:
  
  inName - The command name
  
  inHidden - true if the command should be hidden
Method Details
- isHidden
  
  public boolean isHidden()
  
  Specified by:
  
  isHidden in interface QCommandOrGroupType
  
  Returns:
  
  true if this command should be hidden in listings
- 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