IObjectStore

coldbox.system.cache.store

Interface IObjectStore

coldbox.system.cache.store.IObjectStore

Class Attributes:

None

All Known Implementing Classes:

BlackholeStore , ConcurrentSoftReferenceStore , ConcurrentStore , DiskStore , JDBCStore

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.

Method Detail

clear

public any<Boolean> clear(any objectKey)

Clears an object from the storage pool

Parameters:: objectKey - The object key

clearAll

public void clearAll()

Clear all elements of the store

expireObject

public void expireObject(any objectKey)

Mark an object for expiration

Parameters:: objectKey - The object key

flush

public void flush()

Flush the store to a permanent storage

get

public any get(any objectKey)

Get an object from the store

Parameters:: objectKey - The key of the object

getIndexer

public any<MetadataIndexer> getIndexer()

Get the store's pool metadata indexer structure

getKeys

public any<Array> getKeys()

Get all the store's object keys array

getQuiet

public any getQuiet(any objectKey)

Get an object from the store with no stat updates

Parameters:: objectKey - The key of the object

getSize

public any<numeric> getSize()

Get the store's size

isExpired

public any<Boolean> isExpired(any objectKey)

Test if an object in the store has expired or not

Parameters:: objectKey - The object key

lookup

public any lookup(any objectKey)

Check if an object is in the store

Parameters:: objectKey - The key of the object

reap

public void reap()

Reap the storage, clean it from old stuff

set

public void set(any objectKey, any object, [any timeout], [any lastAccessTimeout], [any extras])

sets an object in the storage.

Parameters:: objectKey - The object key; object - The object to save; timeout - Timeout in minutes; lastAccessTimeout - Timeout in minutes; extras - A map of extra name-value pairs