Package com.tameif.tame

Class TAMECommand

java.lang.Object

com.tameif.tame.TAMECommand

public class TAMECommand
extends java.lang.Object

TAME processed command item. Not to be confused with TAction.

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method and Description
static TAMECommand	create(TAction action) Creates a general action item to execute later.
static TAMECommand	create(TAction action, TObject object) Creates a transitive action item to execute later.
static TAMECommand	create(TAction action, TObject object1, TObject object2) Creates a ditransitive action item to execute later.
static TAMECommand	create(TAction action, java.lang.String target) Creates a modal or open action item to execute later.
TAction	getAction() Gets the action to call.
TObject	getObject1() Gets the first object.
TObject	getObject2() Gets the second object.
java.lang.String	getTarget() Gets the open target.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TAMECommand create(TAction action)

Creates a general action item to execute later.

Parameters:

action - the action to call.

Returns:

a new TAME action item.

Throws:

java.lang.IllegalArgumentException - if the action provided is not a general one.

create

public static TAMECommand create(TAction action,
                                 java.lang.String target)

Creates a modal or open action item to execute later.

Parameters:

action - the action to call.

target - the open target.

Returns:

a new TAME action item.

Throws:

java.lang.IllegalArgumentException - if the action provided is not a modal or open one.

create

public static TAMECommand create(TAction action,
                                 TObject object)

Creates a transitive action item to execute later.

Parameters:

action - the action to call.

object - the first object.

Returns:

a new TAME action item.

Throws:

java.lang.IllegalArgumentException - if the action provided is not a transitive or ditransitive one.

create

public static TAMECommand create(TAction action,
                                 TObject object1,
                                 TObject object2)

Creates a ditransitive action item to execute later.

Parameters:

action - the action to call.

object1 - the first object.

object2 - the second object.

Returns:

a new TAME action item.

Throws:

java.lang.IllegalArgumentException - if the action provided is not a ditransitive one.

getAction

public TAction getAction()

Gets the action to call.

Returns:

the returned action.

getTarget

public java.lang.String getTarget()

Gets the open target.

Returns:

the open target, if any.

getObject1

public TObject getObject1()

Gets the first object.

Returns:

the first object, if any.

getObject2

public TObject getObject2()

Gets the second object.

Returns:

the second object, if any.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object