View Javadoc

    1   /***
    2    * @(#)CacheService.java
    3    *
    4    * JFoxSOAF, Service-Oriented Application Framework
    5    *
    6    * Copyright(c) JFoxSOAF Team
    7    *
    8    * Licensed under the GNU LGPL, Version 2.1 (the "License");
    9    * you may not use this file except in compliance with the License.
    10   * You may obtain a copy of the License at
    11   *
    12   * http://www.gnu.org/copyleft/lesser.html
    13   *
    14   * Unless required by applicable law or agreed to in writing, software
    15   * distributed under the License is distributed on an "AS IS" BASIS,
    16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    17   * See the License for the specific language governing permissions and
    18   * limitations under the License.
    19   *
    20   * For more information, please visit:
    21   * http://www.jfox.cn/confluence/display/JFoxSOAF/Home
    22   * http://www.huihoo.org/jfox/jfoxsoaf
    23   */
    24
    25  package org.huihoo.jfox.soaf.services.cache;
    26
    27  import org.huihoo.jfox.soaf.exception.CacheServiceException;
    28
    29  /***
    30   * <p>
    31   * A cache, being a mechanism for efficient temporary storage of objects for the
    32   * purpose of improving the overall performance of an application system
    33   * </p>
    34   *
    35   * @author <a href="mailto:founder_chen@yahoo.com.cn">Peter Cheng </a>
    36   * @version $Revision: 1.1 $ $Date: 2005/05/22 06:48:52 $
    37   * @version Revision: 1.0
    38   */
    39  public interface CacheService {
    40
    41      /***
    42       * The get method will return, from the cache, the object associated with
    43       * the argument "key".
    44       *
    45       * @param key whose associated value is to be returned
    46       * @return the value to which this cache maps the specified key, or null if
    47       *         the cache contains no mapping for this key.
    48       * @throws CacheException
    49       */
    50      public Object get(Object key) throws CacheServiceException;
    51
    52      /***
    53       * The put method adds the object "value" to the cache identified by the
    54       * object "key".
    55       *
    56       * @param key
    57       * @param value
    58       * @throws CacheServiceException
    59       */
    60      public void put(Object key, Object value) throws CacheServiceException;
    61
    62      /***
    63       * The remove method will delete the object from the cache including the
    64       * key, the associated value and the associated CacheStatistics object.
    65       */
    66      public void remove(Object key) throws CacheServiceException;
    67
    68      /***
    69       * The clear method will remove all objects from the cache including the
    70       * key, the associated value and the associated CacheStatistics object.
    71       */
    72      public void clear() throws CacheServiceException;
    73
    74  }