net.sourceforge.anotherfsm

Class ContainerEvent<T>

java.lang.Object

net.sourceforge.anotherfsm.ContainerEvent<T>

All Implemented Interfaces:

Event

Direct Known Subclasses:

CharacterEvent

public class ContainerEvent<T>
extends java.lang.Object
implements Event

Event that contains another (whatever) object. The stored object is used for comparison while processing the events too.

Author:

Michal Turek

Constructor Summary

Constructors

Constructor and Description
ContainerEvent(T storedObject) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compare the objects using internal fields.
T	getStoredObject() Get the stored object.
int	hashCode() Get the hash code of the object.
java.lang.String	toString() The string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerEvent

public ContainerEvent(T storedObject)

Create the object. The internal state of the stored object must be unmodifiable or never modified to verify the state machine works correctly. The behavior and return values of its hashCode() and equals() must remain unchanged after possible object modification. Completely unmodifiable objects with all member variables final are recommended.

Parameters:

storedObject - the object to store

Method Detail

getStoredObject

public T getStoredObject()

Get the stored object.

Returns:

the stored object

hashCode

public int hashCode()

Description copied from interface: Event

Get the hash code of the object.

Specified by:

hashCode in interface Event

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: Event

Compare the objects using internal fields. FSM uses this method while determining which transition process.

Specified by:

equals in interface Event

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object

Returns:

true if the objects are same, otherwise false

See Also:

Processor.process(Event)

toString

public java.lang.String toString()

Description copied from interface: Event

The string representation of the object. It is expected the class name and all fields used in equals() are listed.

Specified by:

toString in interface Event

Overrides:

toString in class java.lang.Object

Returns:

the string representation