X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=support%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fcache%2FForeverCache.java;h=3ed5a54a1eb096412ae82d228a3c93b5a8903a89;hb=ddd261f331280640c5b53c7128230b629ebcd268;hp=8b7f8bf483a3c497e5cb90d583bb167e2f29813c;hpb=32a62ca2c752e33a7873ac868a7a1f289caedcd4;p=utils

diff --git a/support/general/src/main/java/org/wamblee/cache/ForeverCache.java b/support/general/src/main/java/org/wamblee/cache/ForeverCache.java
index 8b7f8bf4..3ed5a54a 100644
--- a/support/general/src/main/java/org/wamblee/cache/ForeverCache.java
+++ b/support/general/src/main/java/org/wamblee/cache/ForeverCache.java
@@ -1,79 +1,103 @@
 /*
  * Copyright 2005 the original author or authors.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.wamblee.cache;
 
 import java.io.Serializable;
+
 import java.util.HashMap;
 
+
 /**
- * A very simple cache based on a HashMap, It never expires any entries, and has
- * no bounds on its size.
+ * A very simple cache based on a HashMap, It never expires any entries,
+ * and has no bounds on its size.
  *
  * @author Erik Brakkee
+ *
+ * @param <KeyType> DOCUMENT ME!
+ * @param <ValueType> DOCUMENT ME!
  */
 public class ForeverCache<KeyType extends Serializable, ValueType extends Serializable>
-        implements Cache<KeyType, ValueType> {
-
+    implements Cache<KeyType, ValueType> {
     /**
      * Cached entries.
      */
-    private HashMap<KeyType, ValueType> _map;
+    private HashMap<KeyType, ValueType> map;
 
-    /**
+/**
      * Constructs the cache.
-     * 
+     *
      */
     public ForeverCache() {
-        _map = new HashMap<KeyType, ValueType>();
+        map = new HashMap<KeyType, ValueType>();
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.cache.Cache#put(KeyType, ValueType)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aKey DOCUMENT ME!
+     * @param aValue DOCUMENT ME!
+     */
     public synchronized void put(KeyType aKey, ValueType aValue) {
-        _map.put(aKey, aValue);
+        map.put(aKey, aValue);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.cache.Cache#get(KeyType)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aKey DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public synchronized ValueType get(KeyType aKey) {
-        return _map.get(aKey);
+        return map.get(aKey);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.cache.Cache#remove(KeyType)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aKey DOCUMENT ME!
+     */
     public synchronized void remove(KeyType aKey) {
-        _map.remove(aKey);
+        map.remove(aKey);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.cache.Cache#clear()
      */
+    /**
+     * DOCUMENT ME!
+     */
     public synchronized void clear() {
-        _map.clear();
+        map.clear();
     }
 }