HollowState (OpenJPA Parent POM 2.4.0 API)

java.lang.Object
- org.apache.openjpa.kernel.PCState
- - org.apache.openjpa.kernel.HollowState

All Implemented Interfaces:

Serializable
```
 class HollowState
extends PCState
```
Lifecycle state. Represents a hollow instance that exists in the data store, but whose state has not been loaded and who is not active in the current transaction (if any). This may be the state of instances returned on ID lookups or by traversing relations, and the state of persistent instances outside of transactions (unless the retainValues flag is set in the Broker).

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

Constructors
Constructor and Description

HollowState()

Constructors
Constructor and Description
`HollowState()`

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) PCState`	`beforeNontransactionalRead(StateManagerImpl context, int field)` Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being read outside of an active transaction.
`(package private) PCState`	`beforeNontransactionalWrite(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 outside of an active transaction.
`(package private) PCState`	`beforeOptimisticRead(StateManagerImpl context, int field)` Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being read in an optimistic transaction.
`(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`	`beforeRead(StateManagerImpl context, int field)` Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being read within an active 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`	`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) void`	`initialize(StateManagerImpl context, PCState previous)` 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) PCState`	`release(StateManagerImpl context)` Perform any actions necesssary and return the proper lifecycle state on a call to `Broker#makeTransient` with the given instance.
`String`	`toString()`
`(package private) PCState`	`transactional(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.

Methods inherited from class org.apache.openjpa.kernel.PCState
afterNontransactionalRefresh, afterOptimisticRefresh, afterRefresh, beforeFlush, commit, commitRetain, error, evict, flush, isDeleted, isDirty, isNew, isPendingTransactional, isProvisional, isTransactional, isVersionCheckRequired, nonprovisional, nontransactional, persist, readResolve, rollback, rollbackRestore

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HollowState
```
HollowState()
```
- Method Detail
  - initialize
```
void initialize(StateManagerImpl context,
              PCState previous)
```
    Description copied from class: PCState
    
    Called when this state is first assigned to the given state manager.
    
    Overrides:
    
    initialize 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
  - transactional
```
PCState transactional(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:
    
    transactional 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
  - beforeRead
```
PCState beforeRead(StateManagerImpl context,
                 int field)
```
    Description copied from class: PCState
    
    Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being read within an active transaction. The given field number can be -1 if it is a general object read. Returns the this pointer by default.
    
    Overrides:
    
    beforeRead in class PCState
  - beforeOptimisticRead
```
PCState beforeOptimisticRead(StateManagerImpl context,
                           int field)
```
    Description copied from class: PCState
    
    Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being read in an optimistic transaction. The given field number can be -1 if it is a general object read. Returns the this pointer by default.
    
    Overrides:
    
    beforeOptimisticRead in class PCState
  - beforeNontransactionalRead
```
PCState beforeNontransactionalRead(StateManagerImpl context,
                                 int field)
```
    Description copied from class: PCState
    
    Perform any actions necesssary and return the proper lifecycle state prior to the state of the given instance being read outside of an active transaction. The given field number can be -1 if it is a general object read. Returns the this pointer by default.
    
    Overrides:
    
    beforeNontransactionalRead 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
  - beforeNontransactionalWrite
```
PCState beforeNontransactionalWrite(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 outside of an active transaction. The mutate parameter tells if it is a direct mutation on an SCO field. Returns the this pointer by default.
    
    Overrides:
    
    beforeNontransactionalWrite 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

Class HollowState

Field Summary

Fields inherited from class org.apache.openjpa.kernel.PCState

Constructor Summary

Method Summary

Methods inherited from class org.apache.openjpa.kernel.PCState

Methods inherited from class java.lang.Object

Constructor Detail

HollowState

Method Detail

initialize

delete

transactional

release

beforeRead

beforeOptimisticRead

beforeNontransactionalRead

beforeWrite

beforeOptimisticWrite

beforeNontransactionalWrite

isPersistent

toString