X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=support%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fcache%2FCache.java;h=62af5943ef60947ae46b0306844d67d6768557d8;hb=5ddf0de8b6ecb45f2420c9b2e68f82cb7c52dfbb;hp=92df65ec26d31f1bf02ce597d3685d3cceb96225;hpb=ddd261f331280640c5b53c7128230b629ebcd268;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 92df65ec..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,12 +1,12 @@
/*
- * 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.
* 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.
@@ -17,36 +17,39 @@ 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.
+ * 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.
+ *
+ * @param aKey
+ * Key.
+ * @param aValue
+ * Value.
*/
void put(KeyType aKey, ValueType aValue);
/**
* Retrieves a value from the cache.
- *
- * @param aKey Key to retrieve.
- *
- * @return Key.
+ *
+ * @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.
+ *
+ * @param aKey
+ * Key to remove the entry for.
*/
void remove(KeyType aKey);