Callable

Class

ColdBox Platform - WireBox Version 1.2.0

FRAMES

wirebox.system.cache.store
Interface IObjectStore

WEB-INF.cftags.interface
        wirebox.system.cache.store.IObjectStore

All Known Implementing Classes:: BlackholeStore , ConcurrentSoftReferenceStore , ConcurrentStore , DiskStore , JDBCStore

public interface IObjectStore
extends WEB-INF.cftags.interface
extends WEB-INF.cftags.interface

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

Method Detail

clear

public any<Boolean> clear(any objectKey)

Clears an object from the storage pool

clearAll

public void clearAll()

Clear all elements of the store

expireObject

public void expireObject(any objectKey)

Mark an object for expiration

flush

public void flush()

Flush the store to a permanent storage

get

public any get(any objectKey)

Get an object from the store

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

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

lookup

public any lookup(any objectKey)

Check if an object is in the store

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.

Overview

Package