1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18
19 package org.apache.jetspeed.cache;
20
21 /***
22 * <p>
23 * Provides interface to cached elements
24 * Abstraction around atual cache implementation
25 * </p>
26 *
27 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
28 * @version $Id: $
29 */
30 public interface CacheElement
31 {
32 public static int ActionAdded = 1;
33 public static int ActionChanged = 2;
34 public static int ActionRemoved = -1;
35 public static int ActionEvicted = -2;
36 public static int ActionExpired = -3;
37
38
39 /***
40 *
41 * @return the idle time in seconds for this cache element
42 */
43 int getTimeToIdleSeconds();
44
45 /***
46 *
47 * @return the idle time in seconds for this cache element
48 */
49 int getTimeToLiveSeconds();
50
51 void setTimeToLiveSeconds(int timeToLive);
52
53 void setTimeToIdleSeconds(int timeToIdle);
54
55 Object getContent();
56
57 Object getKey();
58
59 boolean isEternal();
60
61 void setEternal(boolean eternal);
62
63
64
65 }