1 /* Open Source Java Caching Service
2 * Copyright (C) 2002 Frank Karlstrøm
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * The author can be contacted by email: fjankk@users.sourceforge.net
18 */
19 package javax.util.jcache;
20
21 /**
22 * class wich holds information about an object in the cache. For information
23 * purposes only.
24 * @deprecated removed with no replacement.
25 * @author Frank Karlstrøm
26 */
27 public interface CacheObjectInfo {
28 String NEVER_EXPIRES = "Object does not expire";
29
30 /**
31 * returns the region the object resides in.
32 *
33 * @return the region the object resides in.
34 */
35 String getRegion();
36
37 /**
38 * returns the name of the object.
39 *
40 * @return the name of the object.
41 */
42 String getName();
43
44 /**
45 * returns the type of the object. (Memory object, disk object, group,
46 * region)
47 *
48 * @return the type of the object.
49 */
50 String getType();
51
52 /**
53 * returns the group the object is associated with.
54 *
55 * @return the group the object is associated with.
56 */
57 String getGroup();
58
59 /**
60 * returns the current reference count to the object.
61 *
62 * @return the current reference count to the object.
63 */
64 int getRefCount();
65
66 /**
67 * returns the total number of accesses to this object.
68 *
69 * @return the total number of accesses to this object.
70 */
71 int getAccesses();
72
73 /**
74 * Return the time the object will expire if any.
75 *
76 * @return the time the object will expire if any
77 */
78 String getExpire();
79 }