1 package org.apache.commons.jcs.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 */ 34 public interface ICacheElement<K, V> 35 extends Serializable 36 { 37 38 /** 39 * Gets the cacheName attribute of the ICacheElement<K, V> object. The cacheName 40 * is also known as the region name. 41 * 42 * @return The cacheName value 43 */ 44 String getCacheName(); 45 46 /** 47 * Gets the key attribute of the ICacheElement<K, V> object 48 * 49 * @return The key value 50 */ 51 K getKey(); 52 53 /** 54 * Gets the val attribute of the ICacheElement<K, V> object 55 * 56 * @return The val value 57 */ 58 V getVal(); 59 60 /** 61 * Gets the attributes attribute of the ICacheElement<K, V> object 62 * 63 * @return The attributes value 64 */ 65 IElementAttributes getElementAttributes(); 66 67 /** 68 * Sets the attributes attribute of the ICacheElement<K, V> object 69 * 70 * @param attr 71 * The new attributes value 72 */ 73 void setElementAttributes( IElementAttributes attr ); 74 }