path: root/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointWorkingSetCache.java

/*******************************************************************************
 * Copyright (c) 2000, 2013 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.debug.internal.ui.views.breakpoints;

import java.util.HashMap;
import java.util.Vector;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.internal.ui.IInternalDebugUIConstants;
import org.eclipse.debug.internal.ui.importexport.breakpoints.IImportExportConstants;
import org.eclipse.osgi.util.NLS;
import org.eclipse.ui.IWorkingSet;
import org.eclipse.ui.IWorkingSetManager;
import org.eclipse.ui.PlatformUI;

/**
 * Class to cache the breakpoint to working set information in its underlying
 * marker as breakpoints are moved between breakpoint working sets. It resolves
 * the need for constant attribute lookup and parsing to fix bug 103731
 *
 * @since 3.2
 */
public class BreakpointWorkingSetCache {

	/**
	 * the entire cache
	 * key: marker
	 * value: vector of working sets the marker belongs to
	 */
	HashMap<IMarker, Vector<Object>> fCache = null;

	/**
	 * Default constructor
	 */
	public BreakpointWorkingSetCache() {
		fCache = new HashMap<>(15);
	}

	/**
	 * Adds an entry into the cache
	 * @param marker the marker to add the workingset information about
	 * @param entry the entry to add to the cache
	 */
	public void addEntry(IMarker marker, Object entry) {
		Vector<Object> list = fCache.get(marker);
		if (list == null) {
			list = new Vector<>();
			list.addElement(entry);
			fCache.put(marker, list);
		}
		else {
			if(!list.contains(entry)) {
				list.addElement(entry);
			}
		}
	}

	/**
	 * Removes an item from the list contained under the marker key, not the marker entry
	 * @param marker the marker key to remove the item from
	 * @param entry the entry to remove
	 */
	public void removeMappedEntry(IMarker marker, Object entry) {
		Vector<Object> list = fCache.get(marker);
		if(list != null) {
			list.remove(entry);
		}
	}

	/**
	 * Flushes the cache of only the specified marker
	 * @param marker the marker whose cache is to be flushed
	 */
	public void flushMarkerCache(IMarker marker) {
		IWorkingSetManager manager = PlatformUI.getWorkbench().getWorkingSetManager();
		Vector<Object> list = fCache.get(marker);
		if(list != null) {
			String names = IImportExportConstants.DELIMITER;
			String ids = IImportExportConstants.DELIMITER;
			for(int i = 0; i < list.size(); i++) {
				String name = (String)list.elementAt(i);
				IWorkingSet ws = manager.getWorkingSet(name);
				if(ws != null) {
					names += name+IImportExportConstants.DELIMITER;
					ids += ws.getId()+IImportExportConstants.DELIMITER;
				}
			}
			try {
				marker.setAttribute(IInternalDebugUIConstants.WORKING_SET_NAME, names);
				marker.setAttribute(IInternalDebugUIConstants.WORKING_SET_ID, ids);
			} catch (CoreException e) {
				Object[] errorInfo = { names, ids, marker };
				String errorMessage = NLS.bind("Failed to set working set names {0} and ids {1} on marker {2}", errorInfo); //$NON-NLS-1$
				DebugPlugin.logMessage(errorMessage, e);
			}
		}
	}

}