source/mircoders/global/MRUCache.java

   1 /*\r
   2  * Copyright (C) 2001, 2002  The Mir-coders group\r
   3  *\r
   4  * This file is part of Mir.\r
   5  *\r
   6  * Mir is free software; you can redistribute it and/or modify\r
   7  * it under the terms of the GNU General Public License as published by\r
   8  * the Free Software Foundation; either version 2 of the License, or\r
   9  * (at your option) any later version.\r
  10  *\r
  11  * Mir is distributed in the hope that it will be useful,\r
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14  * GNU General Public License for more details.\r
  15  *\r
  16  * You should have received a copy of the GNU General Public License\r
  17  * along with Mir; if not, write to the Free Software\r
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19  *\r
  20  * In addition, as a special exception, The Mir-coders gives permission to link\r
  21  * the code of this program with the com.oreilly.servlet library, any library\r
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
  24  * the above that use the same license as the above), and distribute linked\r
  25  * combinations including the two.  You must obey the GNU General Public\r
  26  * License in all respects for all of the code used other than the above\r
  27  * mentioned libraries.  If you modify this file, you may extend this exception\r
  28  * to your version of the file, but you are not obligated to do so.  If you do\r
  29  * not wish to do so, delete this exception statement from your version.\r
  30  */\r
  31 \r
  32 package mircoders.global;\r
  33 \r
  34 \r
  35 import java.util.HashMap;\r
  36 import java.util.LinkedList;\r
  37 import java.util.Map;\r
  38 \r
  39 import mir.config.MirPropertiesConfiguration;\r
  40 import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;\r
  41 import mir.log.LoggerWrapper;\r
  42 \r
  43 import mircoders.global.CacheKey;\r
  44 \r
  45 public class MRUCache {\r
  46   private Map cache;\r
  47   private LinkedList mruList;\r
  48   private int cacheMaxItems;\r
  49 \r
  50   private MirPropertiesConfiguration configuration;\r
  51   private LoggerWrapper logger;\r
  52   \r
  53 \r
  54 \r
  55   public MRUCache() {\r
  56     logger = new LoggerWrapper("Global.MRUCache");\r
  57     try {\r
  58       configuration = MirPropertiesConfiguration.instance();\r
  59         }\r
  60     catch (PropertiesConfigExc e) {\r
  61       throw new RuntimeException("Can't get configuration: " + e.getMessage());\r
  62     }\r
  63     cacheMaxItems=Integer.parseInt(configuration.getString("Global.Cache.Items"));\r
  64     cache = new HashMap();\r
  65     mruList= new LinkedList();\r
  66     \r
  67   }\r
  68 \r
  69   /**\r
  70    * Checks if the cache has an object with the specified key  \r
  71    */\r
  72 \r
  73   public boolean hasObject(CacheKey aCacheKey) {\r
  74     synchronized (cache) {\r
  75       return cache.containsKey(aCacheKey);\r
  76     }\r
  77   }\r
  78   \r
  79   /**\r
  80    * Stores an object in the cache by placing it at the top of the\r
  81    * list If the object is in the cache, it promotes it to the top of\r
  82    * the list.  If the object is not in the cache, it adds it to the\r
  83    * top of the list, and then checks the max size of the cache versus\r
  84    * the new size to see if it needs to remove the last element from\r
  85    * the cache.\r
  86    */\r
  87 \r
  88   public void storeObject(CacheKey aCacheKey,Object data) {\r
  89     synchronized (cache) {\r
  90       if (! hasObject(aCacheKey)){\r
  91         // add to the cache\r
  92         cache.put(aCacheKey,data);\r
  93         if (mruList.size() > cacheMaxItems){\r
  94           removeObject((CacheKey) mruList.getLast());\r
  95         }\r
  96       }\r
  97       mruList.remove(aCacheKey);\r
  98       mruList.addFirst(aCacheKey);\r
  99     }\r
 100   }  \r
 101   \r
 102   public void removeObject(CacheKey aCacheKey){\r
 103     synchronized (cache) {\r
 104       mruList.remove(aCacheKey);\r
 105       cache.remove(aCacheKey);\r
 106     }\r
 107   }\r
 108   \r
 109   /**\r
 110    * Moves requested item to front of cache\r
 111    */\r
 112 \r
 113   public Object getObject(CacheKey aCacheKey){\r
 114     synchronized (cache) {\r
 115       mruList.remove(aCacheKey);\r
 116       mruList.addFirst(aCacheKey);\r
 117       return cache.get(aCacheKey);\r
 118     }\r
 119   }\r
 120 }\r
 121 \r
 122 \r
 123 \r