org.datanucleus.state

Class LifeCycleState

java.lang.Object

org.datanucleus.state.LifeCycleState

public abstract class LifeCycleState
extends Object

Base Class representing the life cycle state. Implemented for individual states.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DETACHED_CLEAN Detached-Clean
static int	DETACHED_DIRTY Detached-Dirty
static int	HOLLOW Hollow
static int	ILLEGAL_STATE illegal state
protected boolean	isDeleted
protected boolean	isDirty
protected boolean	isNew
protected boolean	isPersistent
protected boolean	isTransactional
static int	P_CLEAN Persistent-Clean
static int	P_DELETED Persistent-Deleted
static int	P_DIRTY Persistent-Dirty
static int	P_NEW Persistent-New
static int	P_NEW_DELETED Persistent-New-Deleted
static int	P_NONTRANS Persistent-NonTransactional
static int	P_NONTRANS_DIRTY Persistent-NonTransactionalDirty
protected int	stateType
static int	T_CLEAN Transaction-Clean
static int	T_DIRTY Transaction-Dirty
static int	TOTAL total number of states
static int	TRANSIENT transient

Constructor Summary

Constructors

Constructor and Description
LifeCycleState()

Method Summary

Modifier and Type	Method and Description
protected LifeCycleState	changeState(ObjectProvider op, int newStateType) Utility to change state to a new state.
protected LifeCycleState	changeTransientState(ObjectProvider op, int newStateType) Utility to change state to a new state.
boolean	isDeleted() Return whether the object is deleted.
boolean	isDirty() Return whether the object is dirty, ie has been changed (created, updated, deleted) in this Tx.
boolean	isNew() Return whether the object was newly created.
boolean	isPersistent() Return whether the object is persistent.
boolean	isTransactional() Return whether the object is transactional.
int	stateType() Returns the type of the life cycle state
abstract String	toString() Method to return a string version of this object.
LifeCycleState	transitionAttach(ObjectProvider op) Method to transition to persistent-clean.
LifeCycleState	transitionBegin(ObjectProvider op, Transaction tx) Method to transition to transaction begin state.
LifeCycleState	transitionCommit(ObjectProvider op, Transaction tx) Method to transition to commit state.
LifeCycleState	transitionDeletePersistent(ObjectProvider op) Method to transition to delete persistent state.
LifeCycleState	transitionDetach(ObjectProvider op) Method to transition to detached-clean.
LifeCycleState	transitionEvict(ObjectProvider op) Method to transition to evict state.
LifeCycleState	transitionMakeNontransactional(ObjectProvider op) Method to transition to nontransactional state.
LifeCycleState	transitionMakePersistent(ObjectProvider op) Method to transition to persistent state.
LifeCycleState	transitionMakeTransactional(ObjectProvider op, boolean refreshFields) Method to transition to transactional state.
LifeCycleState	transitionMakeTransient(ObjectProvider op, boolean useFetchPlan, boolean detachAllOnCommit) Method to transition to transient state.
LifeCycleState	transitionReadField(ObjectProvider op, boolean isLoaded) Method to transition to read-field state.
LifeCycleState	transitionRefresh(ObjectProvider op) Method to transition to refresh state.
LifeCycleState	transitionRetrieve(ObjectProvider op, boolean fgOnly) Method to transition to retrieve state.
LifeCycleState	transitionRetrieve(ObjectProvider op, FetchPlan fetchPlan) Method to transition to retrieve state.
LifeCycleState	transitionRollback(ObjectProvider op, Transaction tx) Method to transition to rollback state.
LifeCycleState	transitionSerialize(ObjectProvider op) Method to transition when serialised.
LifeCycleState	transitionWriteField(ObjectProvider op) Method to transition to write-field state.

Methods inherited from class java.lang.Object

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

Field Detail

TRANSIENT

public static final int TRANSIENT

transient

See Also:

Constant Field Values

P_NEW

public static final int P_NEW

Persistent-New

See Also:

Constant Field Values

P_CLEAN

public static final int P_CLEAN

Persistent-Clean

See Also:

Constant Field Values

P_DIRTY

public static final int P_DIRTY

Persistent-Dirty

See Also:

Constant Field Values

HOLLOW

public static final int HOLLOW

Hollow

See Also:

Constant Field Values

T_CLEAN

public static final int T_CLEAN

Transaction-Clean

See Also:

Constant Field Values

T_DIRTY

public static final int T_DIRTY

Transaction-Dirty

See Also:

Constant Field Values

P_NEW_DELETED

public static final int P_NEW_DELETED

Persistent-New-Deleted

See Also:

Constant Field Values

P_DELETED

public static final int P_DELETED

Persistent-Deleted

See Also:

Constant Field Values

P_NONTRANS

public static final int P_NONTRANS

Persistent-NonTransactional

See Also:

Constant Field Values

P_NONTRANS_DIRTY

public static final int P_NONTRANS_DIRTY

Persistent-NonTransactionalDirty

See Also:

Constant Field Values

DETACHED_CLEAN

public static final int DETACHED_CLEAN

Detached-Clean

See Also:

Constant Field Values

DETACHED_DIRTY

public static final int DETACHED_DIRTY

Detached-Dirty

See Also:

Constant Field Values

TOTAL

public static final int TOTAL

total number of states

See Also:

Constant Field Values

ILLEGAL_STATE

public static final int ILLEGAL_STATE

illegal state

See Also:

Constant Field Values

isDirty

protected boolean isDirty

isNew

protected boolean isNew

isDeleted

protected boolean isDeleted

isTransactional

protected boolean isTransactional

isPersistent

protected boolean isPersistent

stateType

protected int stateType

Constructor Detail

LifeCycleState

public LifeCycleState()

Method Detail

stateType

public final int stateType()

Returns the type of the life cycle state

Returns:

the type of this life cycle state

changeState

protected final LifeCycleState changeState(ObjectProvider op,
                                           int newStateType)

Utility to change state to a new state.

Parameters:

op - ObjectProvider

newStateType - The new state

Returns:

new LifeCycle state.

changeTransientState

protected final LifeCycleState changeTransientState(ObjectProvider op,
                                                    int newStateType)

Utility to change state to a new state.

Parameters:

op - ObjectProvider

newStateType - The new state

Returns:

new LifeCycle state.

transitionMakePersistent

public LifeCycleState transitionMakePersistent(ObjectProvider op)

Method to transition to persistent state.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionDeletePersistent

public LifeCycleState transitionDeletePersistent(ObjectProvider op)

Method to transition to delete persistent state.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionMakeTransactional

public LifeCycleState transitionMakeTransactional(ObjectProvider op,
                                                  boolean refreshFields)

Method to transition to transactional state.

Parameters:

op - ObjectProvider.

refreshFields - Whether to refresh loaded fields

Returns:

new LifeCycle state.

transitionMakeNontransactional

public LifeCycleState transitionMakeNontransactional(ObjectProvider op)

Method to transition to nontransactional state.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionMakeTransient

public LifeCycleState transitionMakeTransient(ObjectProvider op,
                                              boolean useFetchPlan,
                                              boolean detachAllOnCommit)

Method to transition to transient state.

Parameters:

op - ObjectProvider.

useFetchPlan - to make transient the fields in the fetch plan

detachAllOnCommit - Whether to detach on commit

Returns:

new LifeCycle state.

transitionBegin

public LifeCycleState transitionBegin(ObjectProvider op,
                                      Transaction tx)

Method to transition to transaction begin state.

Parameters:

op - ObjectProvider.

tx - Transaction.

Returns:

new LifeCycle state.

transitionCommit

public LifeCycleState transitionCommit(ObjectProvider op,
                                       Transaction tx)

Method to transition to commit state.

Parameters:

op - ObjectProvider.

tx - the Transaction been committed.

Returns:

new LifeCycle state.

transitionRollback

public LifeCycleState transitionRollback(ObjectProvider op,
                                         Transaction tx)

Method to transition to rollback state.

Parameters:

op - ObjectProvider.

tx - Transaction.

Returns:

new LifeCycle state.

transitionRefresh

public LifeCycleState transitionRefresh(ObjectProvider op)

Method to transition to refresh state.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionEvict

public LifeCycleState transitionEvict(ObjectProvider op)

Method to transition to evict state.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionReadField

public LifeCycleState transitionReadField(ObjectProvider op,
                                          boolean isLoaded)

Method to transition to read-field state.

Parameters:

op - ObjectProvider.

isLoaded - if the field was previously loaded

Returns:

new LifeCycle state.

transitionWriteField

public LifeCycleState transitionWriteField(ObjectProvider op)

Method to transition to write-field state.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionRetrieve

public LifeCycleState transitionRetrieve(ObjectProvider op,
                                         boolean fgOnly)

Method to transition to retrieve state.

Parameters:

op - ObjectProvider.

fgOnly - only retrieve the current fetch group fields

Returns:

new LifeCycle state.

transitionRetrieve

public LifeCycleState transitionRetrieve(ObjectProvider op,
                                         FetchPlan fetchPlan)

Method to transition to retrieve state.

Parameters:

op - ObjectProvider.

fetchPlan - the fetch plan to load fields

Returns:

new LifeCycle state.

transitionDetach

public LifeCycleState transitionDetach(ObjectProvider op)

Method to transition to detached-clean.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionAttach

public LifeCycleState transitionAttach(ObjectProvider op)

Method to transition to persistent-clean.

Parameters:

op - ObjectProvider.

Returns:

new LifeCycle state.

transitionSerialize

public LifeCycleState transitionSerialize(ObjectProvider op)

Method to transition when serialised.

Parameters:

op - ObjectProvider

Returns:

The new LifeCycle state

isDirty

public final boolean isDirty()

Return whether the object is dirty, ie has been changed (created, updated, deleted) in this Tx.

Returns:

Whether the object is dirty.

isNew

public final boolean isNew()

Return whether the object was newly created.

Returns:

Whether the object is new.

isDeleted

public final boolean isDeleted()

Return whether the object is deleted.

Returns:

Whether the object is deleted.

isTransactional

public final boolean isTransactional()

Return whether the object is transactional.

Returns:

Whether the object is transactional.

isPersistent

public final boolean isPersistent()

Return whether the object is persistent.

Returns:

Whether the object is persistent.

toString

public abstract String toString()

Method to return a string version of this object.

Overrides:

toString in class Object

Returns:

String version of the object.