X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=support%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fcache%2FCache.java;h=62af5943ef60947ae46b0306844d67d6768557d8;hb=f50dfbd639154efa6f9bdd0938235c999a508d9a;hp=15f2c508e8feb66ad11e7305a39118fcaba51ada;hpb=dc05aae40ab88d4224d37f53c35d516107a3b031;p=utils
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 15f2c508..62af5943 100644
--- 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 Cache
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 Cache
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 {
-
/**
- * 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();
}