~raginggoblin/infolog/infolog

« back to all changes in this revision

Viewing changes to InfologServer/lib/hibernate-distribution-3.3.2.GA/project/core/src/main/java/org/hibernate/cache/GeneralDataRegion.java

  • Committer: Raging Goblin
  • Date: 2013-11-16 16:51:32 UTC
  • Revision ID: raging_goblin-20131116165132-weujnptzc88uy4ah
Mavenized the project, now using shared project InfologSync

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/*
2
 
 * Hibernate, Relational Persistence for Idiomatic Java
3
 
 *
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.
8
 
 *
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.
12
 
 *
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
16
 
 * for more details.
17
 
 *
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
23
 
 *
24
 
 */
25
 
package org.hibernate.cache;
26
 
 
27
 
/**
28
 
 * Contract for general-purpose cache regions.
29
 
 *
30
 
 * @author Steve Ebersole
31
 
 */
32
 
public interface GeneralDataRegion extends Region {
33
 
 
34
 
        /**
35
 
         * Get an item from the cache.
36
 
         *
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.
40
 
         */
41
 
        public Object get(Object key) throws CacheException;
42
 
 
43
 
        /**
44
 
         * Put an item into the cache.
45
 
         *
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.
49
 
         */
50
 
        public void put(Object key, Object value) throws CacheException;
51
 
 
52
 
        /**
53
 
         * Evict an item from the cache immediately (without regard for transaction
54
 
         * isolation).
55
 
         *
56
 
         * @param key The key of the item to remove
57
 
         * @throws CacheException Indicates a problem accessing the item or region.
58
 
         */
59
 
        public void evict(Object key) throws CacheException;
60
 
 
61
 
        /**
62
 
         * Evict all contents of this particular cache region (without regard for transaction
63
 
         * isolation).
64
 
         *
65
 
         * @throws CacheException Indicates problem accessing the region.
66
 
         */
67
 
        public void evictAll() throws CacheException;
68
 
}