1 package org.apache.commons.jcs3.engine.behavior;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.Serializable;
23
24 /**
25 * Every item is the cache is wrapped in an ICacheElement. This contains
26 * information about the element: the region name, the key, the value, and the
27 * element attributes.
28 * <p>
29 * The element attributes have lots of useful information about each element,
30 * such as when they were created, how long they have to live, and if they are
31 * allowed to be spooled, etc.
32 */
33 public interface ICacheElement<K, V>
34 extends Serializable
35 {
36
37 /**
38 * Gets the cacheName attribute of the ICacheElement<K, V> object. The cacheName
39 * is also known as the region name.
40 *
41 * @return The cacheName value
42 */
43 String getCacheName();
44
45 /**
46 * Gets the key attribute of the ICacheElement<K, V> object
47 *
48 * @return The key value
49 */
50 K getKey();
51
52 /**
53 * Gets the val attribute of the ICacheElement<K, V> object
54 *
55 * @return The val value
56 */
57 V getVal();
58
59 /**
60 * Gets the attributes attribute of the ICacheElement<K, V> object
61 *
62 * @return The attributes value
63 */
64 IElementAttributes getElementAttributes();
65
66 /**
67 * Sets the attributes attribute of the ICacheElement<K, V> object
68 *
69 * @param attr
70 * The new attributes value
71 */
72 void setElementAttributes( IElementAttributes attr );
73 }