com.gooddata.processor

Class Command

java.lang.Object

com.gooddata.processor.Command

public class Command
extends Object

Script command wrapper

Version:

1.0

Author:

Zdenek Svoboda

Constructor Summary

Constructors

Constructor and Description
Command(String command) Constructor
Command(String command, Properties params) Constructor
Command(String command, String params) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	checkParam(String p) Checks if the parameter exists
String	getCommand() Command getter
String	getParam(String p) Returns the parameter value
Properties	getParameters() Paremeters getter
String	getParamMandatory(String p) Returns the command's mandatory parameter value
boolean	match(String cms) Returns true if the command matches the command name
void	paramsProcessed() Checks if there are no extra parameters present Should be called once all valid parameters are processed
void	setCommand(String command) Command setter
void	setParameters(Properties parameters) Parameters setter
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(String command)

Constructor

Parameters:

command - command name

Command

public Command(String command,
               Properties params)

Constructor

Parameters:

command - command name

params - parameters

Command

public Command(String command,
               String params)

Constructor

Parameters:

command - command name

params - parameters

Method Detail

getCommand

public String getCommand()

Command getter

Returns:

command

setCommand

public void setCommand(String command)

Command setter

Parameters:

command - command

getParameters

public Properties getParameters()

Paremeters getter

Returns:

parameters

setParameters

public void setParameters(Properties parameters)

Parameters setter

Parameters:

parameters - command parameters

toString

public String toString()

Overrides:

toString in class Object

match

public boolean match(String cms)

Returns true if the command matches the command name

Parameters:

cms - command name

Returns:

returns true if the command matches the command name, false otherwise

getParamMandatory

public String getParamMandatory(String p)
                         throws InvalidParameterException

Returns the command's mandatory parameter value

Parameters:

p - parameter name

Returns:

the parameter value

Throws:

InvalidParameterException - if the parameter doesn't exist

getParam

public String getParam(String p)

Returns the parameter value

Parameters:

p - parameter name

Returns:

parameter value

checkParam

public boolean checkParam(String p)

Checks if the parameter exists

Parameters:

p - parameter name

Returns:

true if the parameter exists, false othewrwise

paramsProcessed

public void paramsProcessed()

Checks if there are no extra parameters present Should be called once all valid parameters are processed

Throws:

InvalidParameterException - if there are unprocessed parameters