org.oddjob.state

Class GenericState

java.lang.Object

org.oddjob.state.GenericState

All Implemented Interfaces:

java.io.Serializable, State

public class GenericState
extends java.lang.Object
implements State, java.io.Serializable

A State made up of StateFlags.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericState(java.lang.String name, java.util.Collection<StateFlag> flags)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static GenericState	from(State state)
int	hashCode()
boolean	isComplete() Is a job or service complete?
boolean	isDestroyed() The job is destroyed.
boolean	isException() Is a job in an exception state.
boolean	isExecuting() Is the job executing.
boolean	isIncomplete() Is a job or service incomplete.
boolean	isReady() Is a job ready to be executed.
boolean	isStoppable() Can a job be stopped? This is a catch all for jobs that are active or executing.
static boolean	statesEquivalent(State first, State second)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericState

public GenericState(java.lang.String name,
                    java.util.Collection<StateFlag> flags)

Method Detail

isReady

public boolean isReady()

Description copied from interface: State

Is a job ready to be executed.

Specified by:

isReady in interface State

Returns:

true/false.

isExecuting

public boolean isExecuting()

Description copied from interface: State

Is the job executing. This is normally when the thread of execution is still within the job.

Specified by:

isExecuting in interface State

Returns:

true/false.

isStoppable

public boolean isStoppable()

Description copied from interface: State

Can a job be stopped? This is a catch all for jobs that are active or executing.

Specified by:

isStoppable in interface State

Returns:

true/false.

isComplete

public boolean isComplete()

Description copied from interface: State

Is a job or service complete?

Specified by:

isComplete in interface State

Returns:

true/false.

isIncomplete

public boolean isIncomplete()

Description copied from interface: State

Is a job or service incomplete. The implication of incomplete is that it could be retried to be complete at some future date.

Specified by:

isIncomplete in interface State

Returns:

true/false.

isException

public boolean isException()

Description copied from interface: State

Is a job in an exception state. This is generally due to an unexpected error, as opposed to incomplete which in some way is expected.

Specified by:

isException in interface State

Returns:

true/false.

isDestroyed

public boolean isDestroyed()

Description copied from interface: State

The job is destroyed. It is no longer available for anything.

Specified by:

isDestroyed in interface State

Returns:

true/false.

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()

Overrides:

toString in class java.lang.Object

statesEquivalent

public static boolean statesEquivalent(State first,
                                       State second)

from

public static GenericState from(State state)