graphana.operationsystem

Class Command

java.lang.Object

graphana.operationsystem.Operation

graphana.operationsystem.Command

All Implemented Interfaces:

OperationDescFile

public abstract class Command
extends Operation

Constructor Summary

Constructors

Constructor and Description
Command()

Method Summary

Methods

Modifier and Type	Method and Description
ExecutionReturn	execute(MainControl mainControl, ExecutionReturn[] args, genscript.execution.ExecuterTreeElem<?,?> treeElem, java.lang.String inputKey) Execution of the command.
java.lang.String	getOperationTypeAsString() Returns the operation type as a string.

Methods inherited from class graphana.operationsystem.Operation

getDescriptionFilename, getKeyAndAliases, getMainKey, getParameters, getSignature, initialize, setDescFilename, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Command

public Command()

Method Detail

execute

public final ExecutionReturn execute(MainControl mainControl,
                      ExecutionReturn[] args,
                      genscript.execution.ExecuterTreeElem<?,?> treeElem,
                      java.lang.String inputKey)

Execution of the command. This method is called when the user or a script invokes the command.

Parameters:

mainControl - access to the main control of the program.

args - evaluated arguments of the call.

treeElem - the element of the parse tree at which this command was called.

inputKey - the original string with which this command was called in the script or by the user.

Returns:

the return value of the execution (can be an ExecutionError as well).

getOperationTypeAsString

public java.lang.String getOperationTypeAsString()

Description copied from class: Operation

Returns the operation type as a string.

Overrides:

getOperationTypeAsString in class Operation

Returns:

the operation type as a string.