KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > oro > util > CacheFIFO


1 package org.apache.oro.util;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2000 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
29  * must not be used to endorse or promote products derived from this
30  * software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache"
34  * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
35  * name, without prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  *
56  * Portions of this software are based upon software originally written
57  * by Daniel F. Savarese. We appreciate his contributions.
58  */
59
60 import java.util.*;
61
62 /**
63  * This class is a GenericCache subclass implementing a FIFO (First
64  * In First Out) cache replacement policy. In other words, values are
65  * added to the cache until the cache becomes full. Once the cache is full,
66  * if a new pattern is added to the cache, it replaces the first of
67  * the current patterns in the cache to have been added.
68
69  @author <a HREF="dfs@savarese.org">Daniel F. Savarese</a>
70  @version $Id: CacheFIFO.java,v 1.1.1.1 2000/07/23 23:08:54 jon Exp $
71
72  * @see GenericCache
73  */
74
75 public final class CacheFIFO extends GenericCache {
76   private int __curent = 0;
77
78   /**
79    * Creates a CacheFIFO instance with a given cache capacity.
80    * <p>
81    * @param capacity The capacity of the cache.
82    */
83   public CacheFIFO(int capacity) {
84     super(capacity);
85   }
86
87
88   /**
89    * Same as:
90    * <blockquote><pre>
91    * CacheFIFO(GenericCache.DEFAULT_CAPACITY);
92    * </pre></blockquote>
93    */
94   public CacheFIFO(){
95     this(GenericCache.DEFAULT_CAPACITY);
96   }
97
98
99   /**
100    * Adds a value to the cache. If the cache is full, when a new value
101    * is added to the cache, it replaces the first of the current values
102    * in the cache to have been added (i.e., FIFO).
103    * <p>
104    * @param key The key referencing the value added to the cache.
105    * @param value The value to add to the cache.
106    */
107   public final synchronized void addElement(Object JavaDoc key, Object JavaDoc value) {
108     int index;
109     Object JavaDoc obj;
110
111     obj = _table.get(key);
112
113     if(obj != null) {
114       GenericCacheEntry entry;
115
116       // Just replace the value. Technically this upsets the FIFO ordering,
117 // but it's expedient.
118 entry = (GenericCacheEntry)obj;
119       entry._value = value;
120       entry._key = key;
121
122       return;
123     }
124
125     // If we haven't filled the cache yet, put it at the end.
126 if(!isFull()) {
127       index = _numEntries;
128       ++_numEntries;
129     } else {
130       // Otherwise, replace the current pointer, which takes care of
131 // FIFO in a circular fashion.
132 index = __curent;
133
134       if(++__curent >= _cache.length)
135     __curent = 0;
136
137       _table.remove(_cache[index]._key);
138     }
139
140     _cache[index]._value = value;
141     _cache[index]._key = key;
142     _table.put(key, _cache[index]);
143   }
144
145 }
146
Popular Tags