(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 8fdc2e8d24f27450f7999b359f9c3c74e7178aa7..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,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.
@@ -18,10 +18,11 @@ 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> {
     /**
@@ -40,7 +41,7 @@ public interface Cache<KeyType extends Serializable, ValueType extends Serializa
      * @param aKey
      *            Key to retrieve.
      * 
-     * @return Key.
+     * @return Value or null if expired..
      */
     ValueType get(KeyType aKey);