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

   1 /*
   2  * Copyright 2005 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 import java.util.HashMap;
  21
  22
  23 /**
  24  * A very simple cache based on a HashMap, It never expires any entries,
  25  * and has no bounds on its size.
  26  *
  27  * @author Erik Brakkee
  28  *
  29  * @param <KeyType> DOCUMENT ME!
  30  * @param <ValueType> DOCUMENT ME!
  31  */
  32 public class ForeverCache<KeyType extends Serializable, ValueType extends Serializable>
  33     implements Cache<KeyType, ValueType> {
  34     /**
  35      * Cached entries.
  36      */
  37     private HashMap<KeyType, ValueType> map;
  38
  39 /**
  40      * Constructs the cache.
  41      *
  42      */
  43     public ForeverCache() {
  44         map = new HashMap<KeyType, ValueType>();
  45     }
  46
  47     /*
  48      * (non-Javadoc)
  49      *
  50      * @see org.wamblee.cache.Cache#put(KeyType, ValueType)
  51      */
  52     /**
  53      * DOCUMENT ME!
  54      *
  55      * @param aKey DOCUMENT ME!
  56      * @param aValue DOCUMENT ME!
  57      */
  58     public synchronized void put(KeyType aKey, ValueType aValue) {
  59         map.put(aKey, aValue);
  60     }
  61
  62     /*
  63      * (non-Javadoc)
  64      *
  65      * @see org.wamblee.cache.Cache#get(KeyType)
  66      */
  67     /**
  68      * DOCUMENT ME!
  69      *
  70      * @param aKey DOCUMENT ME!
  71      *
  72      * @return DOCUMENT ME!
  73      */
  74     public synchronized ValueType get(KeyType aKey) {
  75         return map.get(aKey);
  76     }
  77
  78     /*
  79      * (non-Javadoc)
  80      *
  81      * @see org.wamblee.cache.Cache#remove(KeyType)
  82      */
  83     /**
  84      * DOCUMENT ME!
  85      *
  86      * @param aKey DOCUMENT ME!
  87      */
  88     public synchronized void remove(KeyType aKey) {
  89         map.remove(aKey);
  90     }
  91
  92     /*
  93      * (non-Javadoc)
  94      *
  95      * @see org.wamblee.cache.Cache#clear()
  96      */
  97     /**
  98      * DOCUMENT ME!
  99      */
 100     public synchronized void clear() {
 101         map.clear();
 102     }
 103 }