org.oddjob.state

Class StateEvent

java.lang.Object

org.oddjob.state.StateEvent

public final class StateEvent
extends java.lang.Object

An instance of this class is produced when a job state changes. It is passed to all JobStateListeners.

Author:

Rob Gordon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateEvent.SerializableNoSource Used to persist the event.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REPLACEMENT_EXCEPTION_TEXT

Constructor Summary

Constructors

Constructor and Description
StateEvent(Stateful job, State jobState) Constructor.
StateEvent(Stateful source, State state, java.util.Date time, java.lang.Throwable exception) Constructor.
StateEvent(Stateful job, State jobState, java.lang.Throwable exception) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Throwable	getException() Get the exception if applicable, null otherwise.
Stateful	getSource()
State	getState() Get the job state.
java.util.Date	getTime() Get the time of the event..
int	hashCode()
StateEvent.SerializableNoSource	serializable() Provide something that can be serialised.
java.lang.String	toString() Override toString.

Methods inherited from class java.lang.Object

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

Field Detail

REPLACEMENT_EXCEPTION_TEXT

public static final java.lang.String REPLACEMENT_EXCEPTION_TEXT

See Also:

Constant Field Values

Constructor Detail

StateEvent

public StateEvent(Stateful source,
                  State state,
                  java.util.Date time,
                  java.lang.Throwable exception)

Constructor.

Parameters:

source - The source of the event.

state - The state.

time - the Time of the event.

exception - The exception if applicable, or null otherwise.

StateEvent

public StateEvent(Stateful job,
                  State jobState,
                  java.lang.Throwable exception)

Constructor.

Parameters:

job - The source of the event.

jobState - The state.

exception - The exception if applicable, or null otherwise.

StateEvent

public StateEvent(Stateful job,
                  State jobState)

Constructor.

Parameters:

job - The source of the event.

jobState - The state.

Method Detail

getSource

public Stateful getSource()

getState

public State getState()

Get the job state.

Returns:

The job state.

getException

public java.lang.Throwable getException()

Get the exception if applicable, null otherwise.

Returns:

The exception of null.

getTime

public java.util.Date getTime()

Get the time of the event..

Returns:

The time.

serializable

public StateEvent.SerializableNoSource serializable()

Provide something that can be serialised. Note the we do not use writeReplace because there would need to be the corresponding readResolve

Returns:

A serializable version of the event without the source.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Override toString.

Overrides:

toString in class java.lang.Object