001package org.apache.commons.jcs.engine.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.Serializable;
023
024/**
025 * Every item is the cache is wrapped in an ICacheElement. This contains
026 * information about the element: the region name, the key, the value, and the
027 * element attributes.
028 * <p>
029 * The element attributes have lots of useful information about each element,
030 * such as when they were created, how long they have to live, and if they are
031 * allowed to be spooled, etc.
032 *
033 */
034public interface ICacheElement<K, V>
035    extends Serializable
036{
037
038    /**
039     * Gets the cacheName attribute of the ICacheElement&lt;K, V&gt; object. The cacheName
040     * is also known as the region name.
041     *
042     * @return The cacheName value
043     */
044    String getCacheName();
045
046    /**
047     * Gets the key attribute of the ICacheElement&lt;K, V&gt; object
048     *
049     * @return The key value
050     */
051    K getKey();
052
053    /**
054     * Gets the val attribute of the ICacheElement&lt;K, V&gt; object
055     *
056     * @return The val value
057     */
058    V getVal();
059
060    /**
061     * Gets the attributes attribute of the ICacheElement&lt;K, V&gt; object
062     *
063     * @return The attributes value
064     */
065    IElementAttributes getElementAttributes();
066
067    /**
068     * Sets the attributes attribute of the ICacheElement&lt;K, V&gt; object
069     *
070     * @param attr
071     *            The new attributes value
072     */
073    void setElementAttributes( IElementAttributes attr );
074}