wamblee.org Git - utils/blob - support/general/src/main/java/org/wamblee/cache/package-info.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 /**
  17  * This package provides an interface for a cache together with several implementations.
  18  * The main interfaces and classes are:
  19  * <ul>
  20  *   <li> {@link Cache}: An interface representing an application-level cache with objects in the
  21  *       cache identified by keys.
  22  *   </li>
  23  *   <li> {@link CachedObject}: An object representing an object in a cache identified through a
  24  *        key. Upon expiry the cached object invokes a callback to recompute (and cache) the object
  25  *        again.
  26  *   </li>
  27  *   <li> {@link ComputedValue}: An object caching a computed value with a computation interface
  28  *      determining whether the object is out of date and allowing recomputation of the value.
  29  *   </li>
  30  * </ul>
  31  */
  32 package org.wamblee.cache;