org.apache.openjpa.kernel
Class ECleanState

java.lang.Object
  extended by org.apache.openjpa.kernel.PCState
      extended by org.apache.openjpa.kernel.ECleanState
All Implemented Interfaces:
Serializable

 class ECleanState
extends PCState

Lifecycle state. Represents an embedded instance that is managed by a StateManager and may be participating in the current transaction, but has not yet been modified.

Author:
Abe White

Field Summary
 
Fields inherited from class org.apache.openjpa.kernel.PCState
ECLEAN, ECOPY, EDELETED, EDIRTY, ENONTRANS, HOLLOW, PCLEAN, PDELETED, PDELETEDFLUSHED, PDIRTY, PNEW, PNEWDELETED, PNEWFLUSHEDDELETED, PNEWFLUSHEDDELETEDFLUSHED, PNEWPROVISIONAL, PNONTRANS, PNONTRANSDELETED, PNONTRANSDIRTY, PNONTRANSNEW, TCLEAN, TDIRTY, TLOADED, TRANSIENT
 
Constructor Summary
ECleanState()
           
 
Method Summary
(package private)  PCState beforeOptimisticWrite(StateManagerImpl context, int field, boolean mutate)
          Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being written within an optimistic transaction.
(package private)  PCState beforeWrite(StateManagerImpl context, int field, boolean mutate)
          Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being written within an active transaction.
(package private)  PCState commit(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on transaction commit.
(package private)  PCState commitRetain(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on transaction commit with the retainValues flag set.
(package private)  PCState delete(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on a call to Broker.delete(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks) with the given instance.
(package private)  PCState evict(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on a call to Broker.evict(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks) with the given instance.
(package private)  void initialize(StateManagerImpl context)
          Called when this state is first assigned to the given state manager.
(package private)  boolean isPersistent()
          Return whether this is a persistent state.
(package private)  boolean isTransactional()
          Return whether this is a transactional state.
(package private)  PCState nontransactional(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on a call to StoreContext.nontransactional(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks) with the given instance.
(package private)  PCState release(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on a call to Broker#makeTransient with the given instance.
(package private)  PCState rollback(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on transaction rollback.
(package private)  PCState rollbackRestore(StateManagerImpl context)
          Perform any actions necesssary and return the proper lifecycle state on transaction rollback with the restoreValues flag set.
 String toString()
           
 
Methods inherited from class org.apache.openjpa.kernel.PCState
afterNontransactionalRefresh, afterOptimisticRefresh, afterRefresh, beforeFlush, beforeNontransactionalRead, beforeNontransactionalWrite, beforeOptimisticRead, beforeRead, error, flush, isDeleted, isDirty, isNew, isPendingTransactional, isProvisional, isVersionCheckRequired, nonprovisional, persist, readResolve, transactional
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ECleanState

ECleanState()
Method Detail

initialize

void initialize(StateManagerImpl context)
Description copied from class: PCState
Called when this state is first assigned to the given state manager.

Overrides:
initialize in class PCState

commit

PCState commit(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on transaction commit. Returns the this pointer by default.

Overrides:
commit in class PCState

commitRetain

PCState commitRetain(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on transaction commit with the retainValues flag set. Returns the this pointer by default.

Overrides:
commitRetain in class PCState

rollback

PCState rollback(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on transaction rollback. Returns the this pointer by default.

Overrides:
rollback in class PCState

rollbackRestore

PCState rollbackRestore(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on transaction rollback with the restoreValues flag set. Returns the this pointer by default.

Overrides:
rollbackRestore in class PCState

delete

PCState delete(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on a call to Broker.delete(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks) with the given instance. Returns the this pointer by default.

Overrides:
delete in class PCState

nontransactional

PCState nontransactional(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on a call to StoreContext.nontransactional(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks) with the given instance. Returns the this pointer by default.

Overrides:
nontransactional in class PCState

release

PCState release(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on a call to Broker#makeTransient with the given instance. Returns the this pointer by default.

Overrides:
release in class PCState

evict

PCState evict(StateManagerImpl context)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state on a call to Broker.evict(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks) with the given instance. Returns the this pointer by default.

Overrides:
evict in class PCState

beforeWrite

PCState beforeWrite(StateManagerImpl context,
                    int field,
                    boolean mutate)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being written within an active transaction. The mutate parameter tells if it is a direct mutation on an SCO field. Returns the this pointer by default.

Overrides:
beforeWrite in class PCState

beforeOptimisticWrite

PCState beforeOptimisticWrite(StateManagerImpl context,
                              int field,
                              boolean mutate)
Description copied from class: PCState
Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being written within an optimistic transaction. The mutate parameter tells if it is a direct mutation on an SCO field. Returns the this pointer by default.

Overrides:
beforeOptimisticWrite in class PCState

isTransactional

boolean isTransactional()
Description copied from class: PCState
Return whether this is a transactional state. Returns false by default.

Overrides:
isTransactional in class PCState

isPersistent

boolean isPersistent()
Description copied from class: PCState
Return whether this is a persistent state. Returns false by default.

Overrides:
isPersistent in class PCState

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.