Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.hibernate.cache
Class OSCache

    java.lang.Object
      org.hibernate.cache.OSCache

All Implemented Interfaces:
  Cache

    public class OSCache

extends Object
implements Cache

Author:
  Mathias Bogaert

Constructor Summary
`OSCache(int refreshPeriod, String cron, String region)`

Method Summary
`void` | `clear()` Clear the cache
`void` | `destroy()` Clean up
`Object` | `get(Object key)` Get an item from the cache, nontransactionally
`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 timestamp
`void` | `put(Object key, Object value)` Add an item to the cache, nontransactionally, with failfast semantics
`Object` | `read(Object key)` Get an item from the cache
`void` | `remove(Object key)` Remove an item from the cache
`void` | `setCacheCapacity(int cacheCapacity)`
`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

### OSCache

    public OSCache(int refreshPeriod,
                   String cron,
                   String region)

Method Detail

### setCacheCapacity

    public void setCacheCapacity(int cacheCapacity)

### get

    public Object get(Object key)
               throws CacheException

  Description copied from interface: `Cache`
  Get an item from the cache, nontransactionally

  Specified by:
    `get` in interface `Cache`
  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

  Description copied from interface: `Cache`
  Add an item to the cache

  Specified by:
    `update` in interface `Cache`
  Throws:
    `CacheException`

### put

    public void put(Object key,
                    Object value)
             throws CacheException

  Description copied from interface: `Cache`
  Add an item to the cache, nontransactionally, with failfast semantics

  Specified by:
    `put` in interface `Cache`
  Throws:
    `CacheException`

### remove

    public void remove(Object key)
                throws CacheException

  Description copied from interface: `Cache`
  Remove an item from the cache

  Specified by:
    `remove` in interface `Cache`
  Throws:
    `CacheException`

### clear

    public void clear()
               throws CacheException

  Description copied from interface: `Cache`
  Clear the cache

  Specified by:
    `clear` in interface `Cache`
  Throws:
    `CacheException`

### destroy

    public void destroy()
                 throws CacheException

  Description copied from interface: `Cache`
  Clean up

  Specified by:
    `destroy` in interface `Cache`
  Throws:
    `CacheException`

### lock

    public void lock(Object key)
              throws CacheException

  Description copied from interface: `Cache`
  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

  Description copied from interface: `Cache`
  If this is a clustered cache, unlock the item

  Specified by:
    `unlock` in interface `Cache`
  Throws:
    `CacheException`

### nextTimestamp

    public long nextTimestamp()

  Description copied from interface: `Cache`
  Generate a timestamp

  Specified by:
    `nextTimestamp` in interface `Cache`

### getTimeout

    public int getTimeout()

  Description copied from interface: `Cache`
  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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2010 Red Hat, Inc. All Rights Reserved.