fr.liglab.adele.icasa.commands

Class AbstractCommand

java.lang.Object

fr.liglab.adele.icasa.commands.AbstractCommand

All Implemented Interfaces:

ICasaCommand

public abstract class AbstractCommand
extends Object
implements ICasaCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected static Signature	EMPTY_SIGNATURE

Fields inherited from interface fr.liglab.adele.icasa.commands.ICasaCommand

DEFAULT_NAMESPACE, PROP_DESCRIPTION, PROP_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractCommand()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addSignature(Signature signature)
Object	execute(InputStream in, PrintStream out, org.json.JSONObject param) Execute a block of code and then returns the result from execution.
abstract Object	execute(InputStream in, PrintStream out, org.json.JSONObject param, Signature signature)
String	getDescription() Get the command description.
Signature	getSignature(int param) Get signature by passing the number of arguments..
boolean	validate(org.json.JSONObject param, Signature signature) To validate the given parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fr.liglab.adele.icasa.commands.ICasaCommand

getName

Field Detail

EMPTY_SIGNATURE

protected static Signature EMPTY_SIGNATURE

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

execute

public Object execute(InputStream in,
             PrintStream out,
             org.json.JSONObject param)
               throws Exception

Description copied from interface: ICasaCommand

Execute a block of code and then returns the result from execution. This method should use in and out stream to print result instead of the direct use of System.in and System.out

Specified by:

execute in interface ICasaCommand

Parameters:

in - : the input stream.

out - : the output stream.

param - a json object of parameters

Returns:

the result from the execution

Throws:

Exception - if anything goes wrong

addSignature

protected void addSignature(Signature signature)

getSignature

public Signature getSignature(int param)

Description copied from interface: ICasaCommand

Get signature by passing the number of arguments..

Specified by:

getSignature in interface ICasaCommand

Returns:

getDescription

public String getDescription()

Get the command description.

Specified by:

getDescription in interface ICasaCommand

Returns:

The description of the Script and command gogo.

validate

public boolean validate(org.json.JSONObject param,
               Signature signature)
                 throws Exception

Description copied from interface: ICasaCommand

To validate the given parameters.

Specified by:

validate in interface ICasaCommand

Parameters:

param - The parameters in JSON format

Returns:

true if all parameters are in the JSON object, false if not. For optional parameters.

Throws:

Exception

execute

public abstract Object execute(InputStream in,
             PrintStream out,
             org.json.JSONObject param,
             Signature signature)
                        throws Exception

Throws:

Exception