2
* Hibernate, Relational Persistence for Idiomatic Java
4
* Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
5
* indicated by the @author tags or express copyright attribution
6
* statements applied by the authors. All third-party contributions are
7
* distributed under license by Red Hat Middleware LLC.
9
* This copyrighted material is made available to anyone wishing to use, modify,
10
* copy, or redistribute it subject to the terms and conditions of the GNU
11
* Lesser General Public License, as published by the Free Software Foundation.
13
* This program is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
18
* You should have received a copy of the GNU Lesser General Public License
19
* along with this distribution; if not, write to:
20
* Free Software Foundation, Inc.
21
* 51 Franklin Street, Fifth Floor
22
* Boston, MA 02110-1301 USA
25
package org.hibernate.cache;
28
* Contract for general-purpose cache regions.
30
* @author Steve Ebersole
32
public interface GeneralDataRegion extends Region {
35
* Get an item from the cache.
37
* @param key The key of the item to be retrieved.
38
* @return the cached object or <tt>null</tt>
39
* @throws CacheException Indicates a problem accessing the item or region.
41
public Object get(Object key) throws CacheException;
44
* Put an item into the cache.
46
* @param key The key under which to cache the item.
47
* @param value The item to cache.
48
* @throws CacheException Indicates a problem accessing the region.
50
public void put(Object key, Object value) throws CacheException;
53
* Evict an item from the cache immediately (without regard for transaction
56
* @param key The key of the item to remove
57
* @throws CacheException Indicates a problem accessing the item or region.
59
public void evict(Object key) throws CacheException;
62
* Evict all contents of this particular cache region (without regard for transaction
65
* @throws CacheException Indicates problem accessing the region.
67
public void evictAll() throws CacheException;