org.eclipse.jdt.internal.core.util.ILRUCacheable.java Source code

Introduction

Here is the source code for org.eclipse.jdt.internal.core.util.ILRUCacheable.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jdt.internal.core.util;

/**
 * Types implementing this interface can occupy a variable amount of space
 * in an LRUCache.  Cached items that do not implement this interface are
 * considered to occupy one unit of space.
 *
 * @see LRUCache
 */
public interface ILRUCacheable {
    /**
     * Returns the space the receiver consumes in an LRU Cache.  The default space
     * value is 1.
     *
     * @return int Amount of cache space taken by the receiver
     */
    public int getCacheFootprint();
}