net.sourceforge.anotherfsm

Class TimeoutEvent

java.lang.Object

net.sourceforge.anotherfsm.TimeoutEvent

All Implemented Interfaces:

Event

public class TimeoutEvent
extends java.lang.Object
implements Event

The timeout event. State machines allow only two transitions of timeout event per state independently to the timeout values. If a state had two same timeout types the first one would be always processed and the second never.

Author:

Michal Turek

See Also:

TimeoutStateMachine, TimeoutEvent.Type.LOOP_RESTART, TimeoutEvent.Type.LOOP_NO_RESTART

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeoutEvent.Type The type of timeout event to specify the behavior on loop transition.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static TimeoutEvent	instance_LOOP_NO_RESTART The instance of the object for use in timeout state machine.
(package private) static TimeoutEvent	instance_LOOP_RESTART The instance of the object for use in timeout state machine.
private long	timeout The timeout in milliseconds.
private TimeoutEvent.Type	type The type of the event.

Constructor Summary

Constructors

Constructor and Description
TimeoutEvent(long timeout, TimeoutEvent.Type type) Deprecated. Prefer instance(long, Type) method instead.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compare the objects using internal fields.
long	getTimeout()
TimeoutEvent.Type	getType()
int	hashCode() Get the hash code of the object.
static TimeoutEvent	instance(long timeout, TimeoutEvent.Type type) Create instance of this class.
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

Field Detail

instance_LOOP_RESTART

static TimeoutEvent instance_LOOP_RESTART

The instance of the object for use in timeout state machine.

instance_LOOP_NO_RESTART

static TimeoutEvent instance_LOOP_NO_RESTART

The instance of the object for use in timeout state machine.

timeout

private final long timeout

The timeout in milliseconds.

type

private final TimeoutEvent.Type type

The type of the event.

Constructor Detail

TimeoutEvent

@Deprecated
public TimeoutEvent(long timeout,
                       TimeoutEvent.Type type)

Deprecated. Prefer instance(long, Type) method instead.

Create the object.

Parameters:

timeout - the timeout in milliseconds, must be positive

type - the type of the event

Method Detail

instance

public static TimeoutEvent instance(long timeout,
                    TimeoutEvent.Type type)

Create instance of this class.

Parameters:

timeout - the timeout in milliseconds, must be positive

type - the type of the event

Returns:

the instance

getTimeout

public long getTimeout()

getType

public TimeoutEvent.Type getType()

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