/*******************************************************************************
 * Copyright (c) 2009 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.core.resource.java;

import org.eclipse.core.resources.IFile;
import org.eclipse.jdt.core.IType;

/**
 * Java persistent type cache - used to hold "external" types
 * 
 * Provisional API: This interface is part of an interim API that is still
 * under development and expected to change significantly before reaching
 * stability. It is available at this early stage to solicit feedback from
 * pioneering adopters on the understanding that any code that uses this API
 * will almost certainly be broken (repeatedly) as the API evolves.
 */
public interface JavaResourcePersistentTypeCache
	extends JavaResourceNode.Root
{

	String PERSISTENT_TYPES_COLLECTION = "persistentTypes"; //$NON-NLS-1$

	/**
	 * Return the size of the cache's persistent types.
	 */
	int persistentTypesSize();

	/**
	 * Add a Java resource persistent type for the specified JDT type to the
	 * cache. Return the new type.
	 */
	JavaResourcePersistentType addPersistentType(IType jdtType);

	/**
	 * Remove all the persistent types associated with the specified JAR file.
	 * Return whether any persistent types were removed.
	 */
	boolean removePersistentTypes(IFile jarFile);

}