Uses of Interface
org.datanucleus.enhancement.Persistable

Packages that use Persistable

Package	Description
org.datanucleus	This package provides classes that are typically externally called, whether that means by developers or by other DataNucleus plugins.
org.datanucleus.enhancement	DataNucleus ByteCode enhancement contract.
org.datanucleus.enhancer	DataNucleus ByteCode enhancer framework.
org.datanucleus.state	Provides classes relating to the life cycle state management of a persistable object.

Uses of Persistable in org.datanucleus

Fields in org.datanucleus declared as Persistable

Modifier and Type	Field	Description
(package private) Persistable	ExecutionContextImpl.ClassDetailsForId.pc

Fields in org.datanucleus with type parameters of type Persistable

Modifier and Type	Field	Description
(package private) Map<Persistable, DNStateManager>	ExecutionContextImpl.ThreadContextInfo.attachedOwnerByObject	Map of the owner of an attached object, keyed by the object.
(package private) Map<Object, Persistable>	ExecutionContextImpl.ThreadContextInfo.attachedPCById	Map of attached PC object keyed by the id.

Methods in org.datanucleus that return Persistable

Modifier and Type	Method	Description
Persistable	ExecutionContext.findObject(Object id, boolean validate)	Shortcut to calling "findObject(id, validate, validate, null)".
Persistable	ExecutionContext.findObject(Object id, boolean validate, boolean checkInheritance, String objectClassName)	Accessor for an object given the object id.
Persistable	ExecutionContext.findObject(Object id, FieldValues fv, Class pcClass, boolean ignoreCache, boolean checkInheritance)	Accessor for an object given the object id and a set of field values to apply to it.
Persistable	ExecutionContextImpl.findObject(Object id, boolean validate)
Persistable	ExecutionContextImpl.findObject(Object id, boolean validate, boolean checkInheritance, String objectClassName)	Accessor for an object given the object id.
Persistable	ExecutionContextImpl.findObject(Object id, FieldValues fv, Class cls, boolean ignoreCache, boolean checkInheritance)
Persistable[]	ExecutionContext.findObjectsById(Object[] ids, boolean validate)	Accessor for objects with the specified identities.
Persistable[]	ExecutionContextImpl.findObjectsById(Object[] identities, boolean validate)
Persistable	ExecutionContext.getObjectFromCache(Object id)	Convenience method to access an object in the cache.
Persistable	ExecutionContextImpl.getObjectFromCache(Object id)	Convenience method to access an object in the cache.
protected Persistable	ExecutionContextImpl.getObjectFromLevel1Cache(Object id)	Convenience method to access an object in the Level 1 cache.
protected Persistable	ExecutionContextImpl.getObjectFromLevel2Cache(Object id)	Convenience method to access an object in the Level 2 cache.
protected Persistable	ExecutionContextImpl.getObjectFromLevel2CacheForUnique(CacheUniqueKey uniKey)	Convenience method to access the identity that corresponds to a unique key, in the Level 2 cache.
Persistable[]	ExecutionContext.getObjectsFromCache(Object[] ids)	Convenience method to access objects in the cache.
Persistable[]	ExecutionContextImpl.getObjectsFromCache(Object[] ids)	Convenience method to access objects in the cache.

Methods in org.datanucleus that return types with arguments of type Persistable

Modifier and Type	Method	Description
protected Map<Object, Persistable>	ExecutionContextImpl.getObjectsFromLevel2Cache(Collection ids)	Convenience method to access a collection of objects from the Level 2 cache.

Methods in org.datanucleus with parameters of type Persistable

Modifier and Type	Method	Description
void	ExecutionContext.replaceObjectId(Persistable pc, Object oldID, Object newID)	Replace the previous object id for a PC object to a new
void	ExecutionContextImpl.replaceObjectId(Persistable pc, Object oldID, Object newID)	Replace the previous object id for a persistable object with a new one.
void	ExecutionContextThreadedImpl.replaceObjectId(Persistable pc, Object oldID, Object newID)

Constructors in org.datanucleus with parameters of type Persistable

Modifier	Constructor	Description
	ClassDetailsForId(Object id, String className, Persistable pc)

Uses of Persistable in org.datanucleus.enhancement

Methods in org.datanucleus.enhancement that return Persistable

Modifier and Type	Method	Description
Persistable	Persistable.dnNewInstance(StateManager sm)	Return a new instance of this class, with the StateManager set to the parameter, and dnFlags set to LOAD_REQUIRED.
Persistable	Persistable.dnNewInstance(StateManager sm, Object oid)	Return a new instance of this class, with the StateManager set to the parameter, key fields initialised to the values in the oid, and dnFlags set to LOAD_REQUIRED.

Methods in org.datanucleus.enhancement with parameters of type Persistable

Modifier and Type	Method	Description
default boolean	StateManager.getBooleanField(Persistable pc, int field, boolean currentValue)	Return the value for the field.
default byte	StateManager.getByteField(Persistable pc, int field, byte currentValue)	Return the value for the field.
default char	StateManager.getCharField(Persistable pc, int field, char currentValue)	Return the value for the field.
default double	StateManager.getDoubleField(Persistable pc, int field, double currentValue)	Return the value for the field.
default float	StateManager.getFloatField(Persistable pc, int field, float currentValue)	Return the value for the field.
default int	StateManager.getIntField(Persistable pc, int field, int currentValue)	Return the value for the field.
default long	StateManager.getLongField(Persistable pc, int field, long currentValue)	Return the value for the field.
default Object	StateManager.getObjectField(Persistable pc, int field, Object currentValue)	Return the value for the field.
Object	StateManager.getObjectId(Persistable pc)	Return the object representing the identity of the calling instance.
default short	StateManager.getShortField(Persistable pc, int field, short currentValue)	Return the value for the field.
default String	StateManager.getStringField(Persistable pc, int field, String currentValue)	Return the value for the field.
Object	StateManager.getTransactionalObjectId(Persistable pc)	Return the object representing the identity of the calling instance.
Object	StateManager.getVersion(Persistable pc)	Return the object representing the version of the calling instance.
boolean	StateManager.isDeleted(Persistable pc)	Tests whether this object has been deleted.
boolean	StateManager.isDirty(Persistable pc)	Tests whether this object is dirty.
boolean	StateManager.isLoaded(Persistable pc, int field)	Return true if the field is cached in the calling instance.
boolean	StateManager.isNew(Persistable pc)	Tests whether this object has been newly made persistent.
boolean	StateManager.isPersistent(Persistable pc)	Tests whether this object is persistent.
boolean	StateManager.isTransactional(Persistable pc)	Tests whether this object is transactional.
void	StateManager.makeDirty(Persistable pc, String fieldName)	Mark the associated Persistable field dirty.
void	StateManager.preSerialize(Persistable pc)	Guarantee that the serializable transactional and persistent fields are loaded into the instance.
void	StateManager.providedBooleanField(Persistable pc, int field, boolean currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedByteField(Persistable pc, int field, byte currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedCharField(Persistable pc, int field, char currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedDoubleField(Persistable pc, int field, double currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedFloatField(Persistable pc, int field, float currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedIntField(Persistable pc, int field, int currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedLongField(Persistable pc, int field, long currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedObjectField(Persistable pc, int field, Object currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedShortField(Persistable pc, int field, short currentValue)	The value of the field requested to be provided to the StateManager.
void	StateManager.providedStringField(Persistable pc, int field, String currentValue)	The value of the field requested to be provided to the StateManager.
boolean	StateManager.replacingBooleanField(Persistable pc, int field)	The replacement value of the field in the calling instance.
byte	StateManager.replacingByteField(Persistable pc, int field)	The replacement value of the field in the calling instance.
char	StateManager.replacingCharField(Persistable pc, int field)	The replacement value of the field in the calling instance.
double	StateManager.replacingDoubleField(Persistable pc, int field)	The replacement value of the field in the calling instance.
byte	StateManager.replacingFlags(Persistable pc)	The owning StateManager uses this method to supply the value of the flags to the Persistable instance.
float	StateManager.replacingFloatField(Persistable pc, int field)	The replacement value of the field in the calling instance.
int	StateManager.replacingIntField(Persistable pc, int field)	The replacement value of the field in the calling instance.
long	StateManager.replacingLongField(Persistable pc, int field)	The replacement value of the field in the calling instance.
Object	StateManager.replacingObjectField(Persistable pc, int field)	The replacement value of the field in the calling instance.
short	StateManager.replacingShortField(Persistable pc, int field)	The replacement value of the field in the calling instance.
StateManager	StateManager.replacingStateManager(Persistable pc, StateManager sm)	Replace the current value of dnStateManager.
String	StateManager.replacingStringField(Persistable pc, int field)	The replacement value of the field in the calling instance.
void	StateManager.setBooleanField(Persistable pc, int field, boolean currentValue, boolean newValue)	Mark the field as modified by the user.
void	StateManager.setByteField(Persistable pc, int field, byte currentValue, byte newValue)	Mark the field as modified by the user.
void	StateManager.setCharField(Persistable pc, int field, char currentValue, char newValue)	Mark the field as modified by the user.
void	StateManager.setDoubleField(Persistable pc, int field, double currentValue, double newValue)	Mark the field as modified by the user.
void	StateManager.setFloatField(Persistable pc, int field, float currentValue, float newValue)	Mark the field as modified by the user.
void	StateManager.setIntField(Persistable pc, int field, int currentValue, int newValue)	Mark the field as modified by the user.
void	StateManager.setLongField(Persistable pc, int field, long currentValue, long newValue)	Mark the field as modified by the user.
void	StateManager.setObjectField(Persistable pc, int field, Object currentValue, Object newValue)	Mark the field as modified by the user.
void	StateManager.setShortField(Persistable pc, int field, short currentValue, short newValue)	Mark the field as modified by the user.
void	StateManager.setStringField(Persistable pc, int field, String currentValue, String newValue)	Mark the field as modified by the user.

Uses of Persistable in org.datanucleus.enhancer

Fields in org.datanucleus.enhancer declared as Persistable

Modifier and Type	Field	Description
(package private) Persistable	EnhancementHelper.Meta.pc	Instance of Persistable, used at runtime to create new instances.

Methods in org.datanucleus.enhancer that return Persistable

Modifier and Type	Method	Description
(package private) Persistable	EnhancementHelper.Meta.getPC()
private static Persistable	EnhancementHelper.getPersistableForClass(Class pcClass)	Look up the instance for a Persistable class.
Persistable	EnhancementHelper.newInstance(Class pcClass, StateManager sm)	Create a new instance of the class and assign its StateManager.
Persistable	EnhancementHelper.newInstance(Class pcClass, StateManager sm, Object oid)	Create a new instance of the class and assign its StateManager and key values from the ObjectId.
protected Persistable	ImplementationCreatorImpl.newInstance(ClassMetaData cmd, ClassLoaderResolver clr)	Constructs an implementation for an abstract class and instantiates it.
protected Persistable	ImplementationCreatorImpl.newInstance(InterfaceMetaData imd, ClassLoaderResolver clr)	Constructs an implementation for an interface and instantiates it.

Methods in org.datanucleus.enhancer with parameters of type Persistable

Modifier and Type	Method	Description
static void	EnhancementHelper.registerClass(Class pcClass, Persistable pc)	Register metadata by class.

Constructors in org.datanucleus.enhancer with parameters of type Persistable

Modifier	Constructor	Description
(package private)	Meta(Persistable pc)	Construct an instance of Meta.

Uses of Persistable in org.datanucleus.state

Classes in org.datanucleus.state that implement interfaces with type arguments of type Persistable

Modifier and Type	Class	Description
class	StateManagerImpl	Implementation of a StateManager, supporting the bytecode enhancement contract of DataNucleus.

Fields in org.datanucleus.state declared as Persistable

Modifier and Type	Field	Description
protected Persistable	StateManagerImpl.myPC	The persistable instance managed by this StateManager.
protected Persistable	SavedState.pc	Copy (shallow) of the Persistable instance when the instance is enlisted in the transaction.

Methods in org.datanucleus.state that return Persistable

Modifier and Type	Method	Description
Persistable	StateManagerImpl.attachCopy(Persistable detachedPC, boolean embedded)	Method to attach a copy of the detached persistable instance and return the (attached) copy.
Persistable	StateManagerImpl.detachCopy(FetchPlanState state)	Method to make detached copy of this instance If the object is detachable then the copy will be migrated to DETACHED state, otherwise will migrate the copy to TRANSIENT.
Persistable	StateManagerImpl.getObject()
Persistable	SavedState.getPC()
Persistable	StateManagerImpl.getReferencedPC()	Accessor for the referenced PC object when we are attaching or detaching.

Methods in org.datanucleus.state with parameters of type Persistable

Modifier and Type	Method	Description
void	StateManagerImpl.attach(Persistable detachedPC)
Persistable	StateManagerImpl.attachCopy(Persistable detachedPC, boolean embedded)	Method to attach a copy of the detached persistable instance and return the (attached) copy.
protected boolean	StateManagerImpl.disconnectClone(Persistable pc)	Method to disconnect any cloned persistence capable objects from their StateManager.
Object	StateManagerImpl.getObjectId(Persistable pc)	Return the object representing the persistent identity of the calling instance.
Object	StateManagerImpl.getTransactionalObjectId(Persistable pc)	Return the object representing the persistent identity of the calling instance.
Object	StateManagerImpl.getVersion(Persistable pc)	Return the object representing the version of the calling instance.
void	StateManagerImpl.initialiseForDetached(Persistable pc, Object id, Object version)	Initialises the StateManager to manage a Persistable object in detached state.
void	StateManagerImpl.initialiseForEmbedded(Persistable pc, boolean copyPc)	Initialises a state manager to manage a provided Persistable instance that will be EMBEDDED/SERIALISED into another Persistable object.
void	StateManagerImpl.initialiseForHollowPreConstructed(Object id, Persistable pc)	Initialises a state manager to manage the given hollow instance having the given object ID.
void	StateManagerImpl.initialiseForPersistentClean(Object id, Persistable pc)	Initialises a state manager to manage the passed persistent instance having the given object ID.
void	StateManagerImpl.initialiseForPersistentNew(Persistable pc, FieldValues preInsertChanges)	Initialises a state manager to manage a transient instance that is becoming newly persistent.
void	StateManagerImpl.initialiseForPNewToBeDeleted(Persistable pc)	Initialises the StateManager to manage a Persistable object that is not persistent but is about to be deleted.
void	StateManagerImpl.initialiseForTransactionalTransient(Persistable pc)	Initialises a state manager to manage a Transactional Transient instance.
boolean	StateManagerImpl.isDeleted(Persistable pc)	Tests whether this object has been deleted.
boolean	StateManagerImpl.isDirty(Persistable pc)	Tests whether this object is dirty.
boolean	StateManagerImpl.isLoaded(Persistable pc, int fieldNumber)	Return true if the field is cached in the calling instance; in this implementation we always return true.
boolean	StateManagerImpl.isNew(Persistable pc)	Tests whether this object has been newly made persistent.
boolean	StateManagerImpl.isPersistent(Persistable pc)	Tests whether this object is persistent.
boolean	StateManagerImpl.isTransactional(Persistable pc)	Tests whether this object is transactional.
void	StateManagerImpl.makeDirty(Persistable pc, String fieldName)	Mark the associated persistable field dirty.
void	StateManagerImpl.preSerialize(Persistable pc)	Guarantee that the serializable transactional and persistent fields are loaded into the instance.
void	StateManagerImpl.providedBooleanField(Persistable ignored, int fieldNumber, boolean currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedByteField(Persistable ignored, int fieldNumber, byte currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedCharField(Persistable ignored, int fieldNumber, char currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedDoubleField(Persistable ignored, int fieldNumber, double currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedFloatField(Persistable ignored, int fieldNumber, float currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedIntField(Persistable ignored, int fieldNumber, int currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedLongField(Persistable ignored, int fieldNumber, long currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedObjectField(Persistable ignored, int fieldNumber, Object currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedShortField(Persistable ignored, int fieldNumber, short currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
void	StateManagerImpl.providedStringField(Persistable ignored, int fieldNumber, String currentValue)	This method is called from the associated persistable when its dnProvideFields() method is invoked.
protected Object	StateManagerImpl.provideField(Persistable pc, int fieldNumber)	Method to retrieve the value of a field from the PC object.
protected void	StateManagerImpl.replaceField(Persistable pc, int fieldNumber, Object value)	Method to change the value of a field in the PC object.
protected void	StateManagerImpl.replaceField(Persistable pc, int fieldNumber, Object value, boolean makeDirty)	Method to change the value of a field in the PC object.
void	StateManagerImpl.replaceManagedPC(Persistable pc)	Method that replaces the PC managed by this StateManager to be the supplied object.
protected void	StateManagerImpl.replaceStateManager(Persistable pc, StateManager sm)	Utility to update the passed object with the passed StateManager (can be null).
boolean	StateManagerImpl.replacingBooleanField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a boolean field.
byte	StateManagerImpl.replacingByteField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a byte field.
char	StateManagerImpl.replacingCharField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a char field.
double	StateManagerImpl.replacingDoubleField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a double field.
byte	StateManagerImpl.replacingFlags(Persistable pc)	The StateManager uses this method to supply the value of dnFlags to the associated persistable instance.
float	StateManagerImpl.replacingFloatField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a float field.
int	StateManagerImpl.replacingIntField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a int field.
long	StateManagerImpl.replacingLongField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a long field.
Object	StateManagerImpl.replacingObjectField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of an Object field.
short	StateManagerImpl.replacingShortField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a short field.
StateManager	StateManagerImpl.replacingStateManager(Persistable pc, StateManager sm)	Replace the current value of StateManager in the Persistable object.
String	StateManagerImpl.replacingStringField(Persistable ignored, int fieldNumber)	This method is invoked by the persistable object's dnReplaceField() method to refresh the value of a String field.
void	StateManagerImpl.setBooleanField(Persistable pc, int fieldNumber, boolean currentValue, boolean newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setByteField(Persistable pc, int fieldNumber, byte currentValue, byte newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setCharField(Persistable pc, int fieldNumber, char currentValue, char newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setDoubleField(Persistable pc, int fieldNumber, double currentValue, double newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setFloatField(Persistable pc, int fieldNumber, float currentValue, float newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setIntField(Persistable pc, int fieldNumber, int currentValue, int newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setLongField(Persistable pc, int fieldNumber, long currentValue, long newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setObjectField(Persistable pc, int fieldNumber, Object currentValue, Object newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setShortField(Persistable pc, int fieldNumber, short currentValue, short newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
void	StateManagerImpl.setStringField(Persistable pc, int fieldNumber, String currentValue, String newValue)	This method is called by the associated Persistable when the corresponding mutator method (setXXX()) is called on the Persistable.
protected void	StateManagerImpl.updateField(Persistable pc, int fieldNumber, Object value)	Convenience method to perform the update of a field value when a setter is invoked.

Method parameters in org.datanucleus.state with type arguments of type Persistable

Modifier and Type	Method	Description
void	StateManagerImpl.initialiseForEmbedded(Class<Persistable> pcClass)	Initialises a state manager to manage an embedded instance of the specified type.

Constructors in org.datanucleus.state with parameters of type Persistable

Modifier	Constructor	Description
	SavedState(Persistable pc, boolean[] loadedFields, byte persistenceFlags)