Removed DOCUMENT ME comments that were generated and applied source code
[utils] / support / general / src / main / java / org / wamblee / cache / EhCache.java
index dd01cd94a9d000a46aae53b1ea93bca50cce894b..1a760fa020687da08818f260425b005201e8ab96 100644 (file)
@@ -28,20 +28,14 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.Serializable;
 
-
 /**
  * Cache implemented on top of EhCache.
- *
+ * 
  * @author Erik Brakkee
- *
- * @param <KeyType> DOCUMENT ME!
- * @param <ValueType> DOCUMENT ME!
+ * 
  */
 public class EhCache<KeyType extends Serializable, ValueType extends Serializable>
     implements org.wamblee.cache.Cache<KeyType, ValueType> {
-    /**
-     * DOCUMENT ME!
-     */
     private static final Logger LOGGER = Logger.getLogger(EhCache.class);
 
     /**
@@ -54,9 +48,9 @@ public class EhCache<KeyType extends Serializable, ValueType extends Serializabl
      */
     private Cache cache;
 
-/**
+    /**
      * Constructs a cache based on EHCache.
-     *
+     * 
      * @param aResource
      *            Resource containing the configuration file for EHCache.
      * @param aCacheName
@@ -70,12 +64,12 @@ public class EhCache<KeyType extends Serializable, ValueType extends Serializabl
         InputStream is = aResource.getInputStream();
 
         try {
-            manager     = new CacheManager(is);
-            cache       = manager.getCache(aCacheName);
+            manager = new CacheManager(is);
+            cache = manager.getCache(aCacheName);
 
             if (cache == null) {
-                LOGGER.warn("Creating cache '" + aCacheName
-                    "' because it is not configured");
+                LOGGER.warn("Creating cache '" + aCacheName +
+                    "' because it is not configured");
                 manager.addCache(aCacheName);
                 cache = manager.getCache(aCacheName);
             }
@@ -87,31 +81,18 @@ public class EhCache<KeyType extends Serializable, ValueType extends Serializabl
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.cache.Cache#put(KeyType, ValueType)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aKey DOCUMENT ME!
-     * @param aValue DOCUMENT ME!
-     */
     public void put(KeyType aKey, ValueType aValue) {
         cache.put(new Element(aKey, aValue));
     }
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.cache.Cache#get(KeyType)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aKey DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public ValueType get(KeyType aKey) {
         try {
             Element element = cache.get(aKey);
@@ -128,26 +109,18 @@ public class EhCache<KeyType extends Serializable, ValueType extends Serializabl
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.cache.Cache#remove(KeyType)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aKey DOCUMENT ME!
-     */
     public void remove(KeyType aKey) {
         cache.remove(aKey);
     }
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.cache.Cache#clear()
      */
-    /**
-     * DOCUMENT ME!
-     */
     public void clear() {
         cache.removeAll();
     }