Removed DOCUMENT ME comments that were generated and applied source code
[utils] / support / general / src / main / java / org / wamblee / cache / Cache.java
index 92df65ec26d31f1bf02ce597d3685d3cceb96225..8fdc2e8d24f27450f7999b359f9c3c74e7178aa7 100644 (file)
@@ -17,36 +17,38 @@ 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. 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.
+     * 
+     * @param aKey
+     *            Key.
+     * @param aValue
+     *            Value.
      */
     void put(KeyType aKey, ValueType aValue);
 
     /**
      * Retrieves a value from the cache.
-     *
-     * @param aKey Key to retrieve.
-     *
+     * 
+     * @param aKey
+     *            Key to retrieve.
+     * 
      * @return Key.
      */
     ValueType get(KeyType aKey);
 
     /**
      * Removes an entry from the cache.
-     *
-     * @param aKey Key to remove the entry for.
+     * 
+     * @param aKey
+     *            Key to remove the entry for.
      */
     void remove(KeyType aKey);