This project has retired. For details please refer to its Attic page.
CacheLevel xref

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   * http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.chemistry.opencmis.client.bindings.cache;
20  
21  import java.io.Serializable;
22  import java.util.Map;
23  
24  /**
25   * Interface for a level of an hierarchical cache.
26   * 
27   * @author <a href="mailto:fmueller@opentext.com">Florian M&uuml;ller</a>
28   * 
29   * @see Cache
30   */
31  public interface CacheLevel extends Serializable {
32  
33      /**
34       * Initialize the cache level.
35       * 
36       * @param parameters
37       *            level parameters
38       */
39      void initialize(Map<String, String> parameters);
40  
41      /**
42       * Adds an object to the cache level.
43       * 
44       * @param value
45       *            the object
46       * @param key
47       *            the key at this level
48       */
49      void put(Object value, String key);
50  
51      /**
52       * Retrieves an object from the cache level.
53       * 
54       * @param key
55       *            the key at this cache level
56       * @return the object or <code>null</code> if the object doesn't exist
57       */
58      Object get(String key);
59  
60      /**
61       * Removes an object from this cache level.
62       * 
63       * @param key
64       *            the key at this cache level
65       */
66      void remove(String key);
67  }