Cache (Hibernate API Documentation) - Hibernate 3.2.4 正式版 API 英文文档

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
Interface Cache

All Known Subinterfaces:: OptimisticCache

All Known Implementing Classes:: EhCache, HashtableCache, OptimisticTreeCache, OSCache, SwarmCache, TreeCache

public interface Cache

Implementors define a caching algorithm. All implementors must be threadsafe.

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

Map toMap()
          optional operation

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

Method Detail

read

public Object read(Object key)
            throws CacheException

Get an item from the cache

Parameters:: key -
Returns:: the cached object or null
Throws:: CacheException

get

public Object get(Object key)
           throws CacheException

Get an item from the cache, nontransactionally

Parameters:: key -
Returns:: the cached object or null
Throws:: CacheException

put

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

Add an item to the cache, nontransactionally, with failfast semantics

Parameters:: key -; value -
Throws:: CacheException

update

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

Add an item to the cache

Parameters:: key -; value -
Throws:: CacheException

remove

public void remove(Object key)
            throws CacheException

Remove an item from the cache

Throws:: CacheException

clear

public void clear()
           throws CacheException

Clear the cache

Throws:: CacheException

destroy

public void destroy()
             throws CacheException

Clean up

Throws:: CacheException

lock

public void lock(Object key)
          throws CacheException

If this is a clustered cache, lock the item

Throws:: CacheException

unlock

public void unlock(Object key)
            throws CacheException

If this is a clustered cache, unlock the item

Throws:: CacheException

nextTimestamp

public long nextTimestamp()

Generate a timestamp

getTimeout

public int getTimeout()

Get a reasonable "lock timeout"

getRegionName

public String getRegionName()

Get the name of the cache region

getSizeInMemory

public long getSizeInMemory()

The number of bytes is this cache region currently consuming in memory.

Returns:: The number of bytes consumed by this region; -1 if unknown or unsupported.

getElementCountInMemory

public long getElementCountInMemory()

The count of entries currently contained in the regions in-memory store.

Returns:: The count of entries in memory; -1 if unknown or unsupported.

getElementCountOnDisk

public long getElementCountOnDisk()

The count of entries currently contained in the regions disk store.

Returns:: The count of entries on disk; -1 if unknown or unsupported.

toMap

public Map toMap()

optional operation