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 * @see Cache
28 */
29 public interface CacheLevel extends Serializable {
30
31 /**
32 * Initialize the cache level.
33 *
34 * @param parameters
35 * level parameters
36 */
37 void initialize(Map<String, String> parameters);
38
39 /**
40 * Adds an object to the cache level.
41 *
42 * @param value
43 * the object
44 * @param key
45 * the key at this level
46 */
47 void put(Object value, String key);
48
49 /**
50 * Retrieves an object from the cache level.
51 *
52 * @param key
53 * the key at this cache level
54 * @return the object or <code>null</code> if the object doesn't exist
55 */
56 Object get(String key);
57
58 /**
59 * Removes an object from this cache level.
60 *
61 * @param key
62 * the key at this cache level
63 */
64 void remove(String key);
65 }