Callable

Class

ColdBox Platform - CacheBox Version 1.3.0

FRAMES

cachebox.system.cache.store
Class BlackholeStore

WEB-INF.cftags.component
        cachebox.system.cache.store.BlackholeStore

All Implemented Interfaces:: IObjectStore

public class BlackholeStore
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

I am the fastest way to cache objects. I am so fast because I dont do anything. I'm really a tool to use when working on caching strategies. When I am in use nothing is cached. It just vanishes.

Constructor Summary
`init(any<ICacheProvider> cacheProvider)` Constructor

Method Summary
`any`	`clear(any objectKey)` Clears an object from the storage pool
`void`	`clearAll()` No work to do
`void`	`expireObject(any objectKey)` Mark an object for expiration
`void`	`flush()` Pretends to flush the store to a permanent storage
`any`	`get(any objectKey)` Returns null
`any`	`getIndexer()` No work to do
`any`	`getKeys()` No work to do
`any`	`getQuiet(any objectKey)` Returns null
`any`	`getSize()` Get the cache's size in items
`any`	`getStoreID()` Get this storage's ID
`any`	`isExpired(any objectKey)` Test if an object in the store has expired or not
`any`	`lookup(any objectKey)` Returns false
`void`	`reap()` Pretends to reap the storage, clean it from old stuff
`void`	`set(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any extras='[runtime expression]'])` Saves an object in a blackhole

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(any<ICacheProvider> cacheProvider)

Constructor

Parameters:: cacheProvider - The associated cache provider as cachebox.system.cache.ICacheProvider

Method Detail

clear

public any clear(any objectKey)

Clears an object from the storage pool

clearAll

public void clearAll()

No work to do. Everything is already in the blackhole.

expireObject

public void expireObject(any objectKey)

Mark an object for expiration

flush

public void flush()

Pretends to flush the store to a permanent storage

get

public any get(any objectKey)

Returns null. This is a blackhole.

getIndexer

public any getIndexer()

No work to do. Everything is already in the blackhole.

getKeys

public any getKeys()

No work to do. Everything is already in the blackhole.

getQuiet

public any getQuiet(any objectKey)

Returns null. This is a blackhole.

getSize

public any getSize()

Get the cache's size in items

getStoreID

public any getStoreID()

Get this storage's ID

isExpired

public any isExpired(any objectKey)

Test if an object in the store has expired or not

lookup

public any lookup(any objectKey)

Returns false. No work to do. Everything is already in the blackhole.

reap

public void reap()

Pretends to reap the storage, clean it from old stuff.

set

public void set(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any extras='[runtime expression]'])

Saves an object in a blackhole. You'll never see it again.

Overview

Package