source code formatting.
[utils] / support / general / src / main / java / org / wamblee / cache / ZeroCache.java
index 55f9cc95dcca23c9972b9036cc05e9cfb375ed5b..aa571eb06b9aa0236d0683523a15f0bdee4aa60b 100644 (file)
@@ -1,61 +1,88 @@
 /*
  * 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;
 
+
 /**
- * A cache that does not cache. This implementation is useful for disabling caching. 
- * Because of this implementation, application code does not need to distinguish 
- * between the situation where it a cache is used and where it isn't. 
+ * A cache that does not cache. This implementation is useful for disabling
+ * caching. Because of this implementation, application code does not need to
+ * distinguish between the situation where it a cache is used and where it
+ * isn't.
  *
  * @author Erik Brakkee
+ *
+ * @param <KeyType> DOCUMENT ME!
+ * @param <ValueType> DOCUMENT ME!
  */
-public class ZeroCache<KeyType extends Serializable, ValueType extends Serializable> 
-   implements Cache<KeyType, ValueType> {
-
-    public ZeroCache() { 
+public class ZeroCache<KeyType extends Serializable, ValueType extends Serializable>
+    implements Cache<KeyType, ValueType> {
+    /**
+     * Creates a new ZeroCache object.
+     */
+    public ZeroCache() {
         // Empty. 
     }
-    
+
     /* (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) {
         // Empty.    
     }
-    
+
     /* (non-Javadoc)
      * @see org.wamblee.cache.Cache#get(KeyType)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aKey DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public ValueType get(KeyType aKey) {
         return null;
     }
-    
+
     /* (non-Javadoc)
      * @see org.wamblee.cache.Cache#remove(KeyType)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aKey DOCUMENT ME!
+     */
     public void remove(KeyType aKey) {
         // Empty   
     }
-    
+
     /* (non-Javadoc)
      * @see org.wamblee.cache.Cache#clear()
      */
+    /**
+     * DOCUMENT ME!
+     */
     public void clear() {
         // Empty   
     }