edu.usc.ict.iago.utils

Class Event

java.lang.Object

edu.usc.ict.iago.utils.Event

public class Event
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.EventClass Event explanations for sending Events to the Client: SEND_EXPRESSION will be handled by animating the VH face.
static class	Event.SubClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Event(int owner, Event.EventClass eventClass) Specialized constructor used to create a GAME_START or GAME_END event.
	Event(int owner, Event.EventClass eventClass, Event.SubClass sc, int value, java.lang.String message, int delay) Constructor used to create a SEND_MESSAGE event with an integer value (for BATNA etc.)
	Event(int owner, Event.EventClass eventClass, Event.SubClass sc, java.lang.String message, int delay) Constructor used to create a SEND_MESSAGE event
	Event(int owner, Event.EventClass eventClass, int delay) Constructor used to create a FORMAL_ACCEPT, FORMAL_QUIT or OFFER_IN_PROGRESS event.
	Event(int owner, Event.EventClass eventClass, int value, java.lang.String message, int delay) Constructor used to create a SEND_MESSAGE event with an integer value (for BATNA etc.)
	Event(int owner, Event.EventClass eventClass, Offer offer) Deprecated.
	Event(int owner, Event.EventClass eventClass, Offer offer, int delay) Constructor used to create a SEND_OFFER event.
protected	Event(int owner, Event.EventClass eventClass, Offer offer, java.lang.String message, int delay) Specialized constructor usable only by IAGO to add message descriptions of offers.
protected	Event(int owner, Event.EventClass eventClass, java.lang.String time) Specialized constructor used to create a TIME event.
	Event(int owner, Event.EventClass eventClass, java.lang.String message, int delay) Constructor used to create a SEND_MESSAGE event
	Event(int owner, Event.EventClass eventClass, java.lang.String emotion, int duration, int delay) Constructor used to create a SEND_EXPRESSION event

Method Summary

Modifier and Type	Method and Description
void	encodeMessageCode(int code) Specialized method for sending the ID of a known plaintext message to make text parsing easier.
void	encodePreferenceData(Preference preference) Specialized method for sending messages as the more easily parsable Preference class.
boolean	equals(java.lang.Object ePrime) Method to find if every important characteristic of an event is identical to those of another.
int	getDelay() Provides the length of time to wait before executing the Event, in milliseconds.
int	getDuration() Provides the length of time an Event will be displayed, in milliseconds.
java.lang.String	getMessage() Provides the message stored in the Event that calls the method.
int	getMessageCode() Deprecated. MessageCode have been replaced with the SubClass system.
Offer	getOffer() Provides the Offer stored in the Event that calls the method.
int	getOwner() Provides the owner of the event that calls the method.
Preference	getPreference() Provides the preference stored in the Event that calls the method.
Event.SubClass	getSubClass() Provides the type of the event that calls the method.
Event.EventClass	getType() Provides the type of the event that calls the method.
int	getValue() Provides the value in the Event, such as a BATNA value included with a message.
boolean	isFlushable() Determines whether or not this Event is classified as "Flushable." Flushable events will be removed from the event queues whenever a priority Event is sent.
boolean	isPriority() Determines whether or not this Event is classified as "Priority." Priority events will flush all flushable Events that are in the queue.
void	setFlushable(boolean flushable) Sets whether or not this Event can be flushable.
void	setOwner(int owner) Sets the owner of an event.
void	setPriority(boolean prio) Sets the priority of an Event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

@Deprecated
public Event(int owner,
                         Event.EventClass eventClass,
                         Offer offer)

Deprecated.

Constructor used to create a SEND_OFFER event.

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_OFFER)

offer - the offer

Event

public Event(int owner,
             Event.EventClass eventClass,
             int delay)

Constructor used to create a FORMAL_ACCEPT, FORMAL_QUIT or OFFER_IN_PROGRESS event.

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a FORMAL_ACCEPT or OFFER_IN_PROGRESS)

delay - delay in milliseconds

Event

public Event(int owner,
             Event.EventClass eventClass,
             java.lang.String emotion,
             int duration,
             int delay)

Constructor used to create a SEND_EXPRESSION event

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_EXPRESSION)

emotion - the emotion to send. Currently supported are: angry, happy, surprised, disgusted, afraid, neutral, sad, insincereSmile

duration - the length of time, in ms, to display the emotion

delay - the delay in milliseconds

Event

public Event(int owner,
             Event.EventClass eventClass,
             java.lang.String message,
             int delay)

Constructor used to create a SEND_MESSAGE event

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_MESSAGE)

message - the message to send

delay - the delay in milliseconds

Event

public Event(int owner,
             Event.EventClass eventClass,
             int value,
             java.lang.String message,
             int delay)

Constructor used to create a SEND_MESSAGE event with an integer value (for BATNA etc.)

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_MESSAGE)

value - an integer representing a BATNA or any other value to be sent through a message

message - the message to send

delay - the delay in milliseconds

Event

public Event(int owner,
             Event.EventClass eventClass,
             Event.SubClass sc,
             java.lang.String message,
             int delay)

Constructor used to create a SEND_MESSAGE event

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_MESSAGE)

message - the message to send

delay - the delay in milliseconds

sc - the subclass of the message

Event

public Event(int owner,
             Event.EventClass eventClass,
             Event.SubClass sc,
             int value,
             java.lang.String message,
             int delay)

Constructor used to create a SEND_MESSAGE event with an integer value (for BATNA etc.)

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_MESSAGE)

value - an integer representing a BATNA or any other value to be sent through a message

message - the message to send

delay - the delay in milliseconds

sc - the subclass of the message

Event

protected Event(int owner,
                Event.EventClass eventClass)

Specialized constructor used to create a GAME_START or GAME_END event.

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a GAME_START or GAME_END)

Event

protected Event(int owner,
                Event.EventClass eventClass,
                java.lang.String time)

Specialized constructor used to create a TIME event. Usable only by IAGO.

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a TIME)

Event

public Event(int owner,
             Event.EventClass eventClass,
             Offer offer,
             int delay)

Constructor used to create a SEND_OFFER event.

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_OFFER)

offer - the offer

delay - the delay in milliseconds

Event

protected Event(int owner,
                Event.EventClass eventClass,
                Offer offer,
                java.lang.String message,
                int delay)

Specialized constructor usable only by IAGO to add message descriptions of offers.

Parameters:

owner - the integer representing the owner, which matches the ID in History (System = -1, User = 0, Opponent = 1)

eventClass - the type of Event (here, only a SEND_OFFER)

offer - the offer to add a message description to

message - the message associated with the offer

delay - the delay in milliseconds

Method Detail

encodePreferenceData

public void encodePreferenceData(Preference preference)

Specialized method for sending messages as the more easily parsable Preference class. Usable only by IAGO. Only usable for SEND_MESSAGE events.

Parameters:

preference - the preference to send

encodeMessageCode

public void encodeMessageCode(int code)

Specialized method for sending the ID of a known plaintext message to make text parsing easier. Usable only by IAGO. Only usable for SEND_MESSAGE events. Now also sets the SubClass appropriately, for now frozen GameSpec encoding.

Parameters:

code - the known integer code of a given message

getType

public Event.EventClass getType()

Provides the type of the event that calls the method.

Returns:

The type of Event (i.e. SEND_MESSAGE, GAME_START, SEND_OFFER, etc.)

getSubClass

public Event.SubClass getSubClass()

Provides the type of the event that calls the method.

Returns:

The subtype of MessageEvent (i.e. FAVOR)

getMessage

public java.lang.String getMessage()

Provides the message stored in the Event that calls the method.

Returns:

The message associated with the Event.

getOffer

public Offer getOffer()

Provides the Offer stored in the Event that calls the method. Only useful for Offer Events.

Returns:

The Offer associated with the Event.

getDelay

public int getDelay()

Provides the length of time to wait before executing the Event, in milliseconds.

Returns:

The length of time to wait, in milliseconds.

getOwner

public int getOwner()

Provides the owner of the event that calls the method.

Returns:

The int associated with the Event's owner. The int should match an ID in History (System = -1, User = 0, Opponent = 1)

setOwner

public void setOwner(int owner)

Sets the owner of an event. This method is only usable by the Core package and is thus not available to agent developers.

Parameters:

owner - The int of the owner of an event. This should match an ID in History (System = -1, User = 0, Opponent = 1)

getPreference

public Preference getPreference()

Provides the preference stored in the Event that calls the method. Currently only useful for message Events.

Returns:

The Preference associated with the Event.

getMessageCode

public int getMessageCode()

Deprecated. MessageCode have been replaced with the SubClass system.

Provides the message code stored in the Event that calls the method. Only useful for message Events

Returns:

The message code associated with the Event.

getDuration

public int getDuration()

Provides the length of time an Event will be displayed, in milliseconds. Currently only useful for expression Events.

Returns:

The duration of the Event, in milliseconds.

getValue

public int getValue()

Provides the value in the Event, such as a BATNA value included with a message.

Returns:

the value associated with the Event. It is up to the agent calling this method to determine what the value means.

isPriority

public boolean isPriority()

Determines whether or not this Event is classified as "Priority." Priority events will flush all flushable Events that are in the queue. Note: There are two queues that will need to be flushed. The queue of the agent who sends the Priority Event needs to be flushed, and the queue of the adversary's Mediator will need to be flushed.

Returns:

true if the Event has priority. False if it does not.

setPriority

public void setPriority(boolean prio)

Sets the priority of an Event. For the most part, it's up to the agents to determine whether they want an Event to be considered priority or not. Additionally, this method should only be used for outbound events. i.e. an agent should only call this method if it is the owner of the event.

Parameters:

prio - true if the agent wants the Event to have priority. False if it does not.

isFlushable

public boolean isFlushable()

Determines whether or not this Event is classified as "Flushable." Flushable events will be removed from the event queues whenever a priority Event is sent.

Returns:

true if the Event can be flushed. False if it cannot.

setFlushable

public void setFlushable(boolean flushable)

Sets whether or not this Event can be flushable. For the most part, it's up to the agents to determine whether or not their Event is flushable. Additionally, this method should only be used for outbound events. i.e. an agent should only call this method if it is the owner of the event.

Parameters:

flushable - true if the agent wants the Event to be removed from the queue when it sends a priority Event. False if the agent wants the Event to be processed regardless.

equals

public boolean equals(java.lang.Object ePrime)

Method to find if every important characteristic of an event is identical to those of another. Helps with looping detection

Overrides:

equals in class java.lang.Object

Parameters:

boolean - whether the two events are equal or not