org.starhope.appius.user.events
Interface ActionHandlerInterface

All Superinterfaces:

Comparable<Object>

All Known Implementing Classes:

ActionHandler

public interface ActionHandlerInterface
extends Comparable<Object>

This is an interface for an ActionHandler. There's really no reason to use it directly — just call ActionHandler — but it's necessary for preventing circular class dependencies.

Author:

brpocock@star-hope.org

Method Summary

int	compareTo(Object o)
boolean	equals(Object obj)
AbstractUser	getObject()
Room	getRoom()
AbstractUser	getSubject()
ActionMethod	getTarget()
String	getVerb()
int	hashCode()
boolean	invoke(Action action) WRITEME: Document this method brpocock@star-hope.org
boolean	isAnyObject()
boolean	isAnyRoom()
boolean	isAnySubject()
boolean	isAnyVerb()
boolean	isZoneMatch()
boolean	matches(Action action) WRITEME: Document this method brpocock@star-hope.org
void	setAnyObject(boolean newObject)
void	setAnyRoom(boolean newRoom)
void	setAnySubject(boolean newSubject)
void	setAnyVerb(boolean newVerb)
void	setObject(AbstractUser newObject)
void	setRoom(Room newRoom)
void	setSubject(AbstractUser newSubject)
void	setTarget(ActionMethod newTarget)
void	setVerb(String newVerb)
void	setZoneMatch(boolean newMatch)
String	toString()

Method Detail

compareTo

int compareTo(Object o)

Specified by:

compareTo in interface Comparable<Object>

See Also:

Comparable.compareTo(java.lang.Object)

equals

boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getObject

AbstractUser getObject()

Returns:

the myObject

getRoom

Room getRoom()

Returns:

the myRoom

getSubject

AbstractUser getSubject()

Returns:

the mySubject

getTarget

ActionMethod getTarget()

Returns:

the myTarget

getVerb

String getVerb()

Returns:

the myVerb

hashCode

int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

invoke

boolean invoke(Action action)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

action - WRITEME

Returns:

true, if the action has been handled completely

isAnyObject

boolean isAnyObject()

Returns:

the anyObject

isAnyRoom

boolean isAnyRoom()

Returns:

the anyRoom

isAnySubject

boolean isAnySubject()

Returns:

the anySubject

isAnyVerb

boolean isAnyVerb()

Returns:

the anyVerb

isZoneMatch

boolean isZoneMatch()

Returns:

the zoneMatch

matches

boolean matches(Action action)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

action - WRITEME

Returns:

WRITEME

setAnyObject

void setAnyObject(boolean newObject)

Parameters:

newObject - the anyObject to set

setAnyRoom

void setAnyRoom(boolean newRoom)

Parameters:

newRoom - the anyRoom to set

setAnySubject

void setAnySubject(boolean newSubject)

Parameters:

newSubject - the anySubject to set

setAnyVerb

void setAnyVerb(boolean newVerb)

Parameters:

newVerb - the anyVerb to set

setObject

void setObject(AbstractUser newObject)

Parameters:

newObject - the myObject to set

setRoom

void setRoom(Room newRoom)

Parameters:

newRoom - the myRoom to set

setSubject

void setSubject(AbstractUser newSubject)

Parameters:

newSubject - the mySubject to set

setTarget

void setTarget(ActionMethod newTarget)

Parameters:

newTarget - the myTarget to set

setVerb

void setVerb(String newVerb)

Parameters:

newVerb - the myVerb to set

setZoneMatch

void setZoneMatch(boolean newMatch)

Parameters:

newMatch - the zoneMatch to set

toString

String toString()

Overrides:

toString in class Object

See Also:

Object.toString()