d6da8b93ab89c9c9eab1330f547caf0c9d8ecd39
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / core / util / ILRUCacheable.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package net.sourceforge.phpdt.core.util;
12
13 /**
14  * Types implementing this interface can occupy a variable amount of space
15  * in an LRUCache.  Cached items that do not implement this interface are
16  * considered to occupy one unit of space.
17  *
18  * @see LRUCache
19  */
20 public interface ILRUCacheable {
21         /**
22          * Returns the space the receiver consumes in an LRU Cache.  The default space
23          * value is 1.
24          *
25          * @return int Amount of cache space taken by the receiver
26          */
27         public int getCacheFootprint();
28 }