Package jetbrains.buildServer.util.cache

Class SCacheImpl<T>

java.lang.Object

jetbrains.buildServer.util.cache.SCacheImpl<T>

All Implemented Interfaces:

SCache<T>

public abstract class SCacheImpl<T>
extends Object
implements SCache<T>

Author:

kir

Constructor Summary

Constructors

Constructor	Description
SCacheImpl(net.sf.ehcache.Cache storage, int timeToLive, int timeToIdle, Class<T> cachedItemsClass)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Same as SCache.invalidateAll().
abstract void	dispose()	Flushes data on disk (if cache is persistable) and frees all of the resources associated with this cache.
T	fetch(String key, Calculator<T> dataFetcher)	Get data from cache, if available.
void	flush()	Flush all the cache data to the disk
Collection<String>	getKeys()
String	getName()	Name of the cache, as specified upon cache creation
void	invalidate(String key)	Delete cache value for particular key
void	invalidateAll()	Invalidates (removes) all cache elements
boolean	isAlive()
T	read(String key)	Read cache value
void	setAllowToReset(boolean allow)	Specify whether it is allowed to reset this cache from UI from the Diagnostic->Caches page.
void	write(String key, T value)	Put a value to cache with default time to live and time to idle
void	write(String key, T value, int ttlSecs)	Put a value to cache with timeout (time to live)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SCacheImpl

public SCacheImpl(net.sf.ehcache.Cache storage,
                  int timeToLive,
                  int timeToIdle,
                  Class<T> cachedItemsClass)

Method Detail

getName

public String getName()

Description copied from interface: SCache

Name of the cache, as specified upon cache creation

Specified by:

getName in interface SCache<T>

read

public T read(@NotNull
              String key)

Description copied from interface: SCache

Read cache value

Specified by:

read in interface SCache<T>

getKeys

@NotNull
public Collection<String> getKeys()

Specified by:

getKeys in interface SCache<T>

Returns:

keys for values stored in cache

setAllowToReset

public void setAllowToReset(boolean allow)

Description copied from interface: SCache

Specify whether it is allowed to reset this cache from UI from the Diagnostic->Caches page.

Specified by:

setAllowToReset in interface SCache<T>

write

public void write(@NotNull
                  String key,
                  @Nullable
                  T value)

Description copied from interface: SCache

Put a value to cache with default time to live and time to idle

Specified by:

write in interface SCache<T>

Parameters:

key - cache key

value - serializable value. If null, cached value is removed

write

public void write(@NotNull
                  String key,
                  @Nullable
                  T value,
                  int ttlSecs)

Description copied from interface: SCache

Put a value to cache with timeout (time to live)

Specified by:

write in interface SCache<T>

Parameters:

key - cache key

value - serializable value. If null, cached value is removed

ttlSecs - Time to live for cached value in seconds. 0 means no TTL (eternal)

fetch

public T fetch(String key,
               Calculator<T> dataFetcher)

Description copied from interface: SCache

Get data from cache, if available. If not, obtain the data using dataFetcher and put them to the cache. The operation is blocking for a particular key. I.e. multiple fetch operations for a single key will wait until first of them will fill the cache.

Specified by:

fetch in interface SCache<T>

Parameters:

key - cache key

dataFetcher - a procedure to obtain data if it is not found in the cache (data is put to the cache in this case)

Returns:

data from cache or from the dataFetcher

invalidate

public void invalidate(@NotNull
                       String key)

Description copied from interface: SCache

Delete cache value for particular key

Specified by:

invalidate in interface SCache<T>

flush

public void flush()

Description copied from interface: SCache

Flush all the cache data to the disk

Specified by:

flush in interface SCache<T>

destroy

public void destroy()

Description copied from interface: SCache

Same as SCache.invalidateAll().

Specified by:

destroy in interface SCache<T>

invalidateAll

public void invalidateAll()

Description copied from interface: SCache

Invalidates (removes) all cache elements

Specified by:

invalidateAll in interface SCache<T>

isAlive

public boolean isAlive()

dispose

public abstract void dispose()

Description copied from interface: SCache

Flushes data on disk (if cache is persistable) and frees all of the resources associated with this cache.

Specified by:

dispose in interface SCache<T>