SizedCacheable
AllocPage
, CacheableConglomerate
, CachedPage
, CachedStatement
, FileContainer
, InputStreamContainer
, NameTDCacheable
, OIDTDCacheable
, PermissionsCacheable
, RAFContainer
, RAFContainer4
, SequenceUpdater
, SequenceUpdater.BulkInsertUpdater
, SequenceUpdater.SyssequenceUpdater
, SPSNameCacheable
, StoredPage
, TDCacheable
, TempRAFContainer
, VMTypeIdCacheable
public interface Cacheable
A Cacheable object has five states:
CacheManager
,
CacheFactory
,
Class.newInstance()
Modifier and Type | Method | Description |
---|---|---|
void |
clean(boolean forRemove) |
Clean the object.
|
void |
clearIdentity() |
Put the object into the No Identity state.
|
Cacheable |
createIdentity(java.lang.Object key,
java.lang.Object createParameter) |
Create a new item.
|
java.lang.Object |
getIdentity() |
Get the identity of this object.
|
boolean |
isDirty() |
Returns true of the object is dirty.
|
Cacheable |
setIdentity(java.lang.Object key) |
Set the identity of the object.
|
Cacheable setIdentity(java.lang.Object key) throws StandardException
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.
StandardException
- Standard Derby PolicyCacheManager.find(java.lang.Object)
Cacheable createIdentity(java.lang.Object key, java.lang.Object createParameter) throws StandardException
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.
StandardException
- If forCreate is true and the object cannot be created.CacheManager.create(java.lang.Object, java.lang.Object)
void clearIdentity()
java.lang.Object getIdentity()
boolean isDirty()
void clean(boolean forRemove) throws StandardException
StandardException
- Standard Derby error policy.Apache Derby V10.14 Internals - Copyright © 2004,2018 The Apache Software Foundation. All Rights Reserved.