|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.interfacecoldbox.system.cache.store.IObjectStore
public interface IObjectStore
The main interface for CacheBox object storages.
Method Summary | |
---|---|
any<Boolean> |
clear(any objectKey)
Clears an object from the storage pool |
void |
clearAll()
Clear all elements of the store |
void |
expireObject(any objectKey)
Mark an object for expiration |
void |
flush()
Flush the store to a permanent storage |
any |
get(any objectKey)
Get an object from the store |
any<MetadataIndexer> |
getIndexer()
Get the store's pool metadata indexer structure |
any<Array> |
getKeys()
Get all the store's object keys array |
any |
getQuiet(any objectKey)
Get an object from the store with no stat updates |
any<numeric> |
getSize()
Get the store's size |
any<Boolean> |
isExpired(any objectKey)
Test if an object in the store has expired or not |
any |
lookup(any objectKey)
Check if an object is in the store |
void |
reap()
Reap the storage, clean it from old stuff |
void |
set(any objectKey, any object, [any timeout], [any lastAccessTimeout], [any extras])
sets an object in the storage |
Methods inherited from class WEB-INF.cftags.interface |
---|
None
|
Method Detail |
---|
public any<Boolean> clear(any objectKey)
objectKey
- The object keypublic void clearAll()
public void expireObject(any objectKey)
objectKey
- The object keypublic void flush()
public any get(any objectKey)
objectKey
- The key of the objectpublic any<MetadataIndexer> getIndexer()
public any<Array> getKeys()
public any getQuiet(any objectKey)
objectKey
- The key of the objectpublic any<numeric> getSize()
public any<Boolean> isExpired(any objectKey)
objectKey
- The object keypublic any lookup(any objectKey)
objectKey
- The key of the objectpublic void reap()
public void set(any objectKey, any object, [any timeout], [any lastAccessTimeout], [any extras])
objectKey
- The object keyobject
- The object to savetimeout
- Timeout in minuteslastAccessTimeout
- Timeout in minutesextras
- A map of extra name-value pairs
|
ColdBox Platform v3.8.0 | ||||
FRAMES |