wamblee.org Git - utils/blob - support/general/src/main/java/org/wamblee/cache/Cache.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.cache;
  17
  18 import java.io.Serializable;
  19
  20 /**
  21  * The <code>Cache</code> interface represents... a cache. In some circumstances
  22  * it is more optimal to implement caching directly in the code instead of
  23  * relying on Hibernate caching methods. This interface abstracts from the used
  24  * cache implementation. Cache implementations must be thread-safe.
  25  */
  26 public interface Cache<KeyType extends Serializable, ValueType extends Serializable> {
  27     /**
  28      * Adds a key-value pair to the cache.
  29      *
  30      * @param aKey
  31      *            Key.
  32      * @param aValue
  33      *            Value.
  34      */
  35     void put(KeyType aKey, ValueType aValue);
  36
  37     /**
  38      * Retrieves a value from the cache.
  39      *
  40      * @param aKey
  41      *            Key to retrieve.
  42      *
  43      * @return Key.
  44      */
  45     ValueType get(KeyType aKey);
  46
  47     /**
  48      * Removes an entry from the cache.
  49      *
  50      * @param aKey
  51      *            Key to remove the entry for.
  52      */
  53     void remove(KeyType aKey);
  54
  55     /**
  56      * Removes all entries from the cache.
  57      */
  58     void clear();
  59 }