SwarmCache (Hibernate Core Aggregator 3.6.10.Final API)

java.lang.Object
- org.hibernate.cache.SwarmCache

All Implemented Interfaces:

Cache
```
public class SwarmCache
extends Object
implements Cache
```
Author:

Jason Carreira, Gavin King

Constructor Summary

Constructors
Constructor and Description

SwarmCache(net.sf.swarmcache.ObjectCache cache, String regionName)

Constructors
Constructor and Description
`SwarmCache(net.sf.swarmcache.ObjectCache cache, String regionName)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear the cache
`void`	`destroy()` Clean up
`Object`	`get(Object key)` Get an item from the cache
`long`	`getElementCountInMemory()` The count of entries currently contained in the regions in-memory store.
`long`	`getElementCountOnDisk()` The count of entries currently contained in the regions disk store.
`String`	`getRegionName()` Get the name of the cache region
`long`	`getSizeInMemory()` The number of bytes is this cache region currently consuming in memory.
`int`	`getTimeout()` Get a reasonable "lock timeout"
`void`	`lock(Object key)` If this is a clustered cache, lock the item
`long`	`nextTimestamp()` Generate a (coarse) timestamp
`void`	`put(Object key, Object value)` Add an item to the cache
`Object`	`read(Object key)` Get an item from the cache
`void`	`remove(Object key)` Remove an item from the cache
`Map`	`toMap()` optional operation
`String`	`toString()`
`void`	`unlock(Object key)` If this is a clustered cache, unlock the item
`void`	`update(Object key, Object value)` Add an item to the cache

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SwarmCache
```
public SwarmCache(net.sf.swarmcache.ObjectCache cache,
          String regionName)
```
- Method Detail
  - get
```
public Object get(Object key)
           throws CacheException
```
    Get an item from the cache
    
    Specified by:
    
    get in interface Cache
    
    Parameters:
    key -
    
    Returns:
    the cached object or null
    
    Throws:
    
    CacheException
  - read
```
public Object read(Object key)
            throws CacheException
```
    Description copied from interface: Cache
    
    Get an item from the cache
    
    Specified by:
    
    read in interface Cache
    
    Returns:
    the cached object or null
    
    Throws:
    
    CacheException
  - update
```
public void update(Object key,
          Object value)
            throws CacheException
```
    Add an item to the cache
    
    Specified by:
    
    update in interface Cache
    
    Parameters:
    key -
    value -
    
    Throws:
    
    CacheException
  - put
```
public void put(Object key,
       Object value)
         throws CacheException
```
    Add an item to the cache
    
    Specified by:
    
    put in interface Cache
    
    Parameters:
    key -
    value -
    
    Throws:
    
    CacheException
  - remove
```
public void remove(Object key)
            throws CacheException
```
    Remove an item from the cache
    
    Specified by:
    
    remove in interface Cache
    
    Throws:
    
    CacheException
  - clear
```
public void clear()
           throws CacheException
```
    Clear the cache
    
    Specified by:
    
    clear in interface Cache
    
    Throws:
    
    CacheException
  - destroy
```
public void destroy()
             throws CacheException
```
    Clean up
    
    Specified by:
    
    destroy in interface Cache
    
    Throws:
    
    CacheException
  - lock
```
public void lock(Object key)
          throws CacheException
```
    If this is a clustered cache, lock the item
    
    Specified by:
    
    lock in interface Cache
    
    Throws:
    
    CacheException
  - unlock
```
public void unlock(Object key)
            throws CacheException
```
    If this is a clustered cache, unlock the item
    
    Specified by:
    
    unlock in interface Cache
    
    Throws:
    
    CacheException
  - nextTimestamp
```
public long nextTimestamp()
```
    Generate a (coarse) timestamp
    
    Specified by:
    
    nextTimestamp in interface Cache
  - getTimeout
```
public int getTimeout()
```
    Get a reasonable "lock timeout"
    
    Specified by:
    
    getTimeout in interface Cache
  - getRegionName
```
public String getRegionName()
```
    Description copied from interface: Cache
    
    Get the name of the cache region
    
    Specified by:
    
    getRegionName in interface Cache
  - getSizeInMemory
```
public long getSizeInMemory()
```
    Description copied from interface: Cache
    
    The number of bytes is this cache region currently consuming in memory.
    
    Specified by:
    
    getSizeInMemory in interface Cache
    
    Returns:
    The number of bytes consumed by this region; -1 if unknown or unsupported.
  - getElementCountInMemory
```
public long getElementCountInMemory()
```
    Description copied from interface: Cache
    
    The count of entries currently contained in the regions in-memory store.
    
    Specified by:
    
    getElementCountInMemory in interface Cache
    
    Returns:
    The count of entries in memory; -1 if unknown or unsupported.
  - getElementCountOnDisk
```
public long getElementCountOnDisk()
```
    Description copied from interface: Cache
    
    The count of entries currently contained in the regions disk store.
    
    Specified by:
    
    getElementCountOnDisk in interface Cache
    
    Returns:
    The count of entries on disk; -1 if unknown or unsupported.
  - toMap
```
public Map toMap()
```
    Description copied from interface: Cache
    
    optional operation
    
    Specified by:
    
    toMap in interface Cache
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SwarmCache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SwarmCache

Method Detail

get

read

update

put

remove

clear

destroy

lock

unlock

nextTimestamp

getTimeout

getRegionName

getSizeInMemory

getElementCountInMemory

getElementCountOnDisk

toMap

toString