(no commit message)

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

diff --git a/support/general/src/main/java/org/wamblee/cache/Cache.java b/support/general/src/main/java/org/wamblee/cache/Cache.java
index 15f2c508e8feb66ad11e7305a39118fcaba51ada..62af5943ef60947ae46b0306844d67d6768557d8 100644 (file)
--- a/support/general/src/main/java/org/wamblee/cache/Cache.java
+++ b/support/general/src/main/java/org/wamblee/cache/Cache.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2005 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -12,44 +12,49 @@
  * 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;
 
 /**
- * The <code>Cache</code> interface represents... a cache. 
- * In some circumstances it is more optimal to implement caching directly in 
- * the code instead of relying on Hibernate caching methods. This interface abstracts
- * from the used cache implementation. 
- * Cache implementations must be thread-safe.  
+ * The <code>Cache</code> interface represents a cache intended for
+ * application-level caching. In some circumstances it is more optimal to
+ * implement caching directly in the code instead of relying on Hibernate
+ * caching methods. This interface abstracts from the used cache implementation.
+ * Cache implementations must be thread-safe.
  */
 public interface Cache<KeyType extends Serializable, ValueType extends Serializable> {
-
     /**
-     * Adds a key-value pair to the cache. 
-     * @param aKey Key. 
-     * @param aValue Value. 
+     * Adds a key-value pair to the cache.
+     * 
+     * @param aKey
+     *            Key.
+     * @param aValue
+     *            Value.
      */
-    void put(KeyType aKey, ValueType aValue); 
-    
+    void put(KeyType aKey, ValueType aValue);
+
     /**
-     * Retrieves a value from the cache. 
-     * @param aKey Key to retrieve. 
-     * @return Key. 
+     * Retrieves a value from the cache.
+     * 
+     * @param aKey
+     *            Key to retrieve.
+     * 
+     * @return Value or null if expired..
      */
     ValueType get(KeyType aKey);
-    
+
     /**
-     * Removes an entry from the cache. 
-     * @param aKey Key to remove the entry for. 
+     * Removes an entry from the cache.
+     * 
+     * @param aKey
+     *            Key to remove the entry for.
      */
-    void remove(KeyType aKey); 
-    
+    void remove(KeyType aKey);
+
     /**
-     * Removes all entries from the cache. 
-     *
+     * Removes all entries from the cache.
      */
-    void clear(); 
+    void clear();
 }