source/mircoders/global/MRUCache.java

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