fuego.papi
Class Arguments

java.lang.Object
  fuego.papi.Arguments

public class Arguments
extends Object

Field Summary

static String	ACTION argument ACTION contains the value of the predefined instance variable action.
static String	RESULT argument RESULT contains the value of the predefined instance variable action.4 The argument value contained in this key is of STRING type.

Method Summary

boolean	containsArgument(String name) Return if this object contains a specific argument name
static Arguments	create() Create a new Arguments object
static Arguments	create(ArgumentMap arguments) Create a new Arguments object
Object	getArgument(String name) Get the argument value
Map<String,Object>	getArguments() Get a map with all arguments added to this Argument object.
String[]	getArgumentsName() Get all argument names added to this Argument object Returns a String array with all names
boolean	getBooleanArgument(String name) Get the argument value
DynamicObject	getCILArguments()
double	getDoubleArgument(String name) Get the argument value
DynamicObject	getDynamicObject() Return the DynamicObject that represent this object
DynamicObject	getDynamicObjectArgument(String name) Get the argument value
long	getLongArgument(String name) Get the argument value
Time	getTimeArgument(String name) Get the argument value
void	putArgument(String name, boolean value) Put a new argument in this object
void	putArgument(String name, double value) Put a new argument in this object
void	putArgument(String name, DynamicObject value) Put a new argument in this object
void	putArgument(String name, long value) Put a new argument in this object
void	putArgument(String name, Object value) Put a new argument in this object
void	replaceArguments(DynamicObject arguments) Replace all arguments of this Argument object with the DynamicObject (composite) values.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION

@NonNls
public static final String ACTION

argument ACTION contains the value of the predefined instance variable action. The argument value contained in this key is of Long type. Possible values : NONE = 0; OK = 1; FAIL = 2; RELEASE = 3 CANCEL = 4; REPEAT = 5; ABORT = 6; BACK = 7; SKIP = 8; NEXT = 9;

See Also:

Constant Field Values

RESULT

@NonNls
public static final String RESULT

argument RESULT contains the value of the predefined instance variable action.4 The argument value contained in this key is of STRING type.

See Also:

Constant Field Values

Method Detail

create

public static Arguments create()

Create a new Arguments object

create

public static Arguments create(ArgumentMap arguments)

Create a new Arguments object

getArgument

public Object getArgument(String name)

Get the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getArguments

public Map<String,Object> getArguments()

Get a map with all arguments added to this Argument object. The map contains a argument name as key and argument value as value

Returns:

A java.util.Map with Key -> argument name and Value -> argument value

getArgumentsName

public String[] getArgumentsName()

Get all argument names added to this Argument object Returns a String array with all names

getBooleanArgument

public boolean getBooleanArgument(String name)

Get the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getCILArguments

public DynamicObject getCILArguments()

getDoubleArgument

public double getDoubleArgument(String name)

Get the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getDynamicObject

public DynamicObject getDynamicObject()

Return the DynamicObject that represent this object

Returns:

The representation of this object

See Also:

DynamicObject

getDynamicObjectArgument

public DynamicObject getDynamicObjectArgument(String name)

Get the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getLongArgument

public long getLongArgument(String name)

Get the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getTimeArgument

public Time getTimeArgument(String name)

Get the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

See Also:

Time

containsArgument

public boolean containsArgument(String name)

Return if this object contains a specific argument name

Returns:

Return true if this object contains the argument name or false if not.

putArgument

public void putArgument(String name,
                        boolean value)

Put a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        long value)

Put a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        double value)

Put a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        DynamicObject value)

Put a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        Object value)

Put a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

replaceArguments

public void replaceArguments(DynamicObject arguments)

Replace all arguments of this Argument object with the DynamicObject (composite) values.

Parameters:

arguments - The arguments to replace the existing arguments, this DynamicObject must be a composite.