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 intended for
  22  * application-level caching. In some circumstances it is more optimal to
  23  * implement caching directly in the code instead of relying on Hibernate
  24  * caching methods. This interface abstracts from the used cache implementation.
  25  * Cache implementations must be thread-safe.
  26  */
  27 public interface Cache<KeyType extends Serializable, ValueType extends Serializable> {
  28     /**
  29      * Adds a key-value pair to the cache.
  30      *
  31      * @param aKey
  32      *            Key.
  33      * @param aValue
  34      *            Value.
  35      */
  36     void put(KeyType aKey, ValueType aValue);
  37
  38     /**
  39      * Retrieves a value from the cache.
  40      *
  41      * @param aKey
  42      *            Key to retrieve.
  43      *
  44      * @return Value or null if expired..
  45      */
  46     ValueType get(KeyType aKey);
  47
  48     /**
  49      * Removes an entry from the cache.
  50      *
  51      * @param aKey
  52      *            Key to remove the entry for.
  53      */
  54     void remove(KeyType aKey);
  55
  56     /**
  57      * Removes all entries from the cache.
  58      */
  59     void clear();
  60 }