IPersistentDependencyStoreFactory.java

/*******************************************************************************
 * Copyright (c) 2011 Gerd Wuetherich (gerd@gerd-wuetherich.de).
 * 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:
 *     Gerd Wuetherich (gerd@gerd-wuetherich.de) - initial API and implementation
 ******************************************************************************/
package org.bundlemaker.core.spi.store;

import org.bundlemaker.core.project.IProjectDescriptionAwareBundleMakerProject;
import org.eclipse.core.runtime.CoreException;

/**
 * <p>
 * Factory to create instances of type {@link IPersistentDependencyStore} for a given {@link IProjectDescriptionAwareBundleMakerProject}.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface IPersistentDependencyStoreFactory {

  /**
   * <p>
   * Returns a {@link IPersistentDependencyStore} for the specified {@link IProjectDescriptionAwareBundleMakerProject}. Multiple calls to this
   * method will return the identical {@link IPersistentDependencyStore}.
   * </p>
   * 
   * @param project
   * @return
   */
  public IPersistentDependencyStore getPersistentDependencyStore(IProjectDescriptionAwareBundleMakerProject project);

  /**
   * <p>
   * </p>
   * 
   * @param project
   */
  public void releasePersistentDependencyStore(IProjectDescriptionAwareBundleMakerProject project);

  /**
   * <p>
   * Resets the {@link IPersistentDependencyStore} for the specified {@link IProjectDescriptionAwareBundleMakerProject}.
   * </p>
   * 
   * @param project
   * @throws CoreException
   */
  public void resetPersistentDependencyStore(IProjectDescriptionAwareBundleMakerProject project) throws CoreException;
}