source code formatting.

[utils] / support / general / src / main / java / org / wamblee / cache / EhCache.java

diff --git a/support/general/src/main/java/org/wamblee/cache/EhCache.java b/support/general/src/main/java/org/wamblee/cache/EhCache.java
index 0df1e61f165edee1e8741536f9960cea318905ea..dd01cd94a9d000a46aae53b1ea93bca50cce894b 100644 (file)
--- a/support/general/src/main/java/org/wamblee/cache/EhCache.java
+++ b/support/general/src/main/java/org/wamblee/cache/EhCache.java
@@ -1,58 +1,62 @@
 /*
  * 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.IOException;
-import java.io.InputStream;
-import java.io.Serializable;
-
 import net.sf.ehcache.Cache;
 import net.sf.ehcache.CacheException;
 import net.sf.ehcache.CacheManager;
 import net.sf.ehcache.Element;
-import net.sf.ehcache.config.Configuration;
-import net.sf.ehcache.config.ConfigurationFactory;
 
 import org.apache.log4j.Logger;
+
 import org.wamblee.io.InputResource;
 
+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> {
-
+    implements org.wamblee.cache.Cache<KeyType, ValueType> {
+    /**
+     * DOCUMENT ME!
+     */
     private static final Logger LOGGER = Logger.getLogger(EhCache.class);
 
     /**
      * EH Cache manager.
      */
-    private CacheManager _manager;
+    private CacheManager manager;
 
     /**
      * EH cache.
      */
-    private Cache _cache;
+    private Cache cache;
 
-    /**
+/**
      * Constructs a cache based on EHCache.
-     * 
+     *
      * @param aResource
      *            Resource containing the configuration file for EHCache.
      * @param aCacheName
@@ -62,44 +66,60 @@ public class EhCache<KeyType extends Serializable, ValueType extends Serializabl
      * @throws CacheException
      */
     public EhCache(InputResource aResource, String aCacheName)
-            throws IOException, CacheException {
+        throws IOException, CacheException {
         InputStream is = aResource.getInputStream();
+
         try {
-               _manager = new CacheManager(is);
-            _cache = _manager.getCache(aCacheName);
-            if (_cache == null) {
+            manager     = new CacheManager(is);
+            cache       = manager.getCache(aCacheName);
+
+            if (cache == null) {
                 LOGGER.warn("Creating cache '" + aCacheName
-                        + "' because it is not configured");
-                _manager.addCache(aCacheName);
-                _cache = _manager.getCache(aCacheName);
+                    + "' because it is not configured");
+                manager.addCache(aCacheName);
+                cache = manager.getCache(aCacheName);
             }
-            assert _cache != null;
+            assert cache != null;
         } finally {
             is.close();
         }
-
     }
 
     /*
      * (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));
+        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);
+            Element element = cache.get(aKey);
+
             if (element == null) {
                 return null;
             }
+
             return (ValueType) element.getValue();
         } catch (CacheException e) {
             throw new RuntimeException("Cache problem key = '" + aKey + "'", e);
@@ -108,19 +128,27 @@ 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);
+        cache.remove(aKey);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.cache.Cache#clear()
      */
+    /**
+     * DOCUMENT ME!
+     */
     public void clear() {
-        _cache.removeAll();
+        cache.removeAll();
     }
 }