Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.services.bytecode.VMTypeIdCacheable

Modifier and Type	Field and Description
private Object	descriptor
private Object	key

Access	Constructor and Description
pack-priv	VMTypeIdCacheable()

Method Summary

Modifier and Type	Method and Description
public void	clean(boolean True if the object will be removed remove) Implements org.apache.derby.iapi.services.cache.Cacheable.clean. Clean the object.
public void	clearIdentity() Implements org.apache.derby.iapi.services.cache.Cacheable.clearIdentity. Put the object into the No Identity state.
public Cacheable	createIdentity(Object The handle on the cacheable key, Object Creation details createParameter) Implements org.apache.derby.iapi.services.cache.Cacheable.createIdentity. Create a new item.
pack-priv Object	descriptor() Get the VM Type name (java/lang/Object) that is associated with this Cacheable
public Object	getIdentity() Implements org.apache.derby.iapi.services.cache.Cacheable.getIdentity. Get the identity of this object.
public boolean	isDirty() Implements org.apache.derby.iapi.services.cache.Cacheable.isDirty. Returns true if the object is dirty.
public Cacheable	setIdentity(Object The handle on the cacheable key) Implements org.apache.derby.iapi.services.cache.Cacheable.setIdentity. Set the identity of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

descriptor	back to summary
private Object descriptor

key	back to summary
private Object key

VMTypeIdCacheable	back to summary
pack-priv VMTypeIdCacheable()

Method Detail

clean back to summary

clean	back to summary
public void clean(boolean remove) Implements org.apache.derby.iapi.services.cache.Cacheable.clean. Doc from org.apache.derby.iapi.services.cache.Cacheable.clean. Clean the object. It is up to the object to ensure synchronization of the isDirty() and clean() method calls. If forRemove is true then the object is being removed due to an explict remove request, in this case the cache manager will have called this method regardless of the state of the isDirty() If an exception is thrown the object must be left in the clean state. MT - thread safe - Can be called at any time by the cache manager, it is the responsibility of the object implementing Cacheable to ensure any users of the object do not conflict with the clean call. Parameters remove:boolean True if the object will be removed See Also `Cacheable#clean`

public void clean(boolean remove)

Implements org.apache.derby.iapi.services.cache.Cacheable.clean.

Doc from org.apache.derby.iapi.services.cache.Cacheable.clean.

Clean the object. It is up to the object to ensure synchronization of the isDirty() and clean() method calls.
If forRemove is true then the object is being removed due to an explict remove request, in this case the cache manager will have called this method regardless of the state of the isDirty()
If an exception is thrown the object must be left in the clean state.
MT - thread safe - Can be called at any time by the cache manager, it is the responsibility of the object implementing Cacheable to ensure any users of the object do not conflict with the clean call.

Parameters

remove:boolean: True if the object will be removed

See Also

Cacheable#clean

clearIdentity back to summary

clearIdentity	back to summary
public void clearIdentity() Implements org.apache.derby.iapi.services.cache.Cacheable.clearIdentity. Doc from org.apache.derby.iapi.services.cache.Cacheable.clearIdentity. Put the object into the No Identity state. MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it. See Also `Cacheable#clearIdentity`

public void clearIdentity()

Implements org.apache.derby.iapi.services.cache.Cacheable.clearIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.clearIdentity.

Put the object into the No Identity state.
MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it.

See Also: Cacheable#clearIdentity

createIdentity back to summary

createIdentity	back to summary
public Cacheable createIdentity(Object key, Object createParameter) Implements org.apache.derby.iapi.services.cache.Cacheable.createIdentity. Doc from org.apache.derby.iapi.services.cache.Cacheable.createIdentity. Create a new item. Create a new item and set the identity of the object to represent it. The object will be in the No Identity state, ie. it will have just been created or clearIdentity() was just called. The object must copy the information out of key, not just store a reference to key if the key is not immutable. After this call the expression getIdentity().equals(key) must return true. If the class of the object needs to change (e.g. to support a different format) then the object should create a new object, call its initParameter() with the parameters the original object was called with, set its identity and return a reference to it. The cache manager will discard the reference to the old object. If an exception is thrown the object must be left in the no-identity state. MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it. Parameters key:Object The handle on the cacheable createParameter:Object Creation details Returns:Cacheable an object reference if the object can take on the identity, null otherwise. See Also `Cacheable#createIdentity`

public Cacheable createIdentity(Object key, Object createParameter)

Implements org.apache.derby.iapi.services.cache.Cacheable.createIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.createIdentity.

Create a new item.

Create a new item and set the identity of the object to represent it. The object will be in the No Identity state, ie. it will have just been created or clearIdentity() was just called.
The object must copy the information out of key, not just store a reference to key if the key is not immutable. After this call the expression getIdentity().equals(key) must return true.

If the class of the object needs to change (e.g. to support a different format) then the object should create a new object, call its initParameter() with the parameters the original object was called with, set its identity and return a reference to it. The cache manager will discard the reference to the old object.
If an exception is thrown the object must be left in the no-identity state.
MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it.

Parameters

key:Object: The handle on the cacheable
createParameter:Object: Creation details

Returns:Cacheable

an object reference if the object can take on the identity, null otherwise.

See Also

Cacheable#createIdentity

descriptor	back to summary
pack-priv Object descriptor() Get the VM Type name (java/lang/Object) that is associated with this Cacheable

getIdentity back to summary

getIdentity	back to summary
public Object getIdentity() Implements org.apache.derby.iapi.services.cache.Cacheable.getIdentity. Doc from org.apache.derby.iapi.services.cache.Cacheable.getIdentity. Get the identity of this object. MT - thread safe. Returns:Object the object identity See Also `Cacheable#getIdentity`

public Object getIdentity()

Implements org.apache.derby.iapi.services.cache.Cacheable.getIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.getIdentity.

Get the identity of this object.
MT - thread safe.

Returns:Object: the object identity
See Also: Cacheable#getIdentity

isDirty back to summary

isDirty	back to summary
public boolean isDirty() Implements org.apache.derby.iapi.services.cache.Cacheable.isDirty. Doc from org.apache.derby.iapi.services.cache.Cacheable.isDirty. Returns true if the object is dirty. May be called when the object is kept or unkept. MT - thread safe Returns:boolean true if the object is dirty See Also `Cacheable#isDirty`

public boolean isDirty()

Implements org.apache.derby.iapi.services.cache.Cacheable.isDirty.

Doc from org.apache.derby.iapi.services.cache.Cacheable.isDirty.

Returns true if the object is dirty. May be called when the object is kept or unkept.
MT - thread safe

Returns:boolean: true if the object is dirty
See Also: Cacheable#isDirty

setIdentity back to summary

setIdentity	back to summary
public Cacheable setIdentity(Object key) Implements org.apache.derby.iapi.services.cache.Cacheable.setIdentity. Doc from org.apache.derby.iapi.services.cache.Cacheable.setIdentity. Set the identity of the object. Set the identity of the object to represent an item that already exists, e.g. an existing container. The object will be in the No Identity state, ie. it will have just been created or clearIdentity() was just called. The object must copy the information out of key, not just store a reference to key. After this call the expression getIdentity().equals(key) must return true. If the class of the object needs to change (e.g. to support a different format) then the object should create a new object, call its initParameter() with the parameters the original object was called with, set its identity and return a reference to it. The cache manager will discard the reference to the old object. If an exception is thrown the object must be left in the no-identity state. MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it. Parameters key:Object The handle on the cacheable Returns:Cacheable an object reference if the object can take on the identity, null otherwise. See Also `Cacheable#setIdentity`

public Cacheable setIdentity(Object key)

Implements org.apache.derby.iapi.services.cache.Cacheable.setIdentity.

Doc from org.apache.derby.iapi.services.cache.Cacheable.setIdentity.

Set the identity of the object.

Set the identity of the object to represent an item that already exists, e.g. an existing container. The object will be in the No Identity state, ie. it will have just been created or clearIdentity() was just called.
The object must copy the information out of key, not just store a reference to key. After this call the expression getIdentity().equals(key) must return true.
If the class of the object needs to change (e.g. to support a different format) then the object should create a new object, call its initParameter() with the parameters the original object was called with, set its identity and return a reference to it. The cache manager will discard the reference to the old object.
If an exception is thrown the object must be left in the no-identity state.
MT - single thread required - Method must only be called be cache manager and the cache manager will guarantee only one thread can be calling it.

Parameters

key:Object: The handle on the cacheable

Returns:Cacheable

an object reference if the object can take on the identity, null otherwise.

See Also

Cacheable#setIdentity

pack-priv Class VMTypeIdCacheable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail