bundles/org.eclipse.equinox.p2.garbagecollector/src/org/eclipse/equinox/p2/garbagecollector/CoreGarbageCollector.java

/*******************************************************************************
 * Copyright (c) 2007 IBM Corporation and others.
 * 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.equinox.p2.garbagecollector;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.equinox.internal.p2.core.helpers.LogHelper;
import org.eclipse.equinox.p2.artifact.repository.IArtifactRepository;
import org.eclipse.equinox.p2.metadata.IArtifactKey;

/**
 * Given a MarkSet, the CoreGarbageCollector removes any IArtifactDescriptors which
 * are not mapped to be an IArtifactKey in the MarkSet.
 */
public class CoreGarbageCollector {

	/**
	 * When set to true, information will be logged every time an artifact is removed 
	 */
	private static boolean debugMode = false;

	private CoreGarbageCollector() {
		//empty constructor
	}

	/**
	 * Public API.  Run the Garbage Collector on the given MarkSet
	 * @param inRootSet the MarkSet on which a garbage collection is to be run
	 */
	public static void cleanRootSet(MarkSet inRootSet) {
		new CoreGarbageCollector().clean(inRootSet.getKeys(), inRootSet.getRepo());
	}

	/**
	 * Given a list of IArtifactKeys and an IArtifactRepository, removes all artifacts
	 * in aRepository that are not mapped to by an IArtifactKey in rootSet
	 */
	public synchronized void clean(IArtifactKey[] rootSet, IArtifactRepository aRepository) {
		IArtifactKey[] repositoryKeys = aRepository.getArtifactKeys();
		for (int j = 0; j < repositoryKeys.length; j++) {
			boolean artifactIsActive = false;
			for (int k = 0; k < rootSet.length; k++) {
				if (repositoryKeys[j].equals(rootSet[k])) {
					artifactIsActive = true;
					break;
				}
			}
			if (!artifactIsActive) {
				aRepository.removeDescriptor(repositoryKeys[j]);
				if (debugMode) {
					LogHelper.log(new Status(IStatus.INFO, GCActivator.ID, Messages.CoreGarbageCollector_0 + repositoryKeys[j]));
				}
			}
		}
	}

	/**
	 * Convenience method.  Sets debugMode to true then calls clean()
	 */
	public static void cleanRootSetWithInfo(MarkSet inRootSet) {
		setDebugMode(true);
		new CoreGarbageCollector().clean(inRootSet.getKeys(), inRootSet.getRepo());
	}

	/**
	 * If set to true, debug mode will log information about each artifact deleted by the CoreGarbageCollector
	 * @param inDebugMode
	 */
	public static void setDebugMode(boolean inDebugMode) {
		if (inDebugMode) {
			LogHelper.log(new Status(Status.INFO, GCActivator.ID, Messages.CoreGarbageCollector_1));
		}
		debugMode = inDebugMode;
	}

}