View Javadoc

1   /*
2    * Copyright (c) 2009-2012 The 99 Software Foundation
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20   * THE SOFTWARE.
21   */
22  package org.nnsoft.sameas4j.cache;
23  
24  /**
25   * Simple cache interface for sameas service.
26   */
27  public interface Cache {
28  
29      /**
30       * Add a new entry in the cache.
31       *
32       * @param <T> The stored object type
33       * @param cacheKey The cache key
34       * @param cacheValue The stored object
35       */
36      <T> void put(CacheKey cacheKey, T cacheValue);
37  
38      /**
39       * Retrieves an object from the cache.
40       *
41       * @param <T> The stored object type
42       * @param cacheKey The cache key
43       * @param type The stored object
44       * @return The stored object if any, null otherwise
45       */
46      <T> T get(CacheKey cacheKey, Class<T> type);
47  
48  }