debug/org.eclipse.ptp.debug.ui/src/org/eclipse/ptp/debug/internal/ui/OverlayImageCache.java

/*******************************************************************************
 * Copyright (c) 2005 The Regents of the University of California. 
 * This material was produced under U.S. Government contract W-7405-ENG-36 
 * for Los Alamos National Laboratory, which is operated by the University 
 * of California for the U.S. Department of Energy. The U.S. Government has 
 * rights to use, reproduce, and distribute this software. NEITHER THE 
 * GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR 
 * ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified 
 * to produce derivative works, such modified software should be clearly marked, 
 * so as not to confuse it with the version available from LANL.
 * 
 * Additionally, 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
 * 
 * LA-CC 04-115
 *******************************************************************************/
package org.eclipse.ptp.debug.internal.ui;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.eclipse.swt.graphics.Image;

/**
 * @author Clement chu
 *
 */
public class OverlayImageCache {
	private Map<OverlayImageDescriptor, Image> cache = new HashMap<OverlayImageDescriptor, Image>();

	/** Get image 
	 * @param imageDescriptor
	 * @return
	 */
	public Image getImageFor(OverlayImageDescriptor imageDescriptor) {
		Image image = (Image)getCache().get(imageDescriptor);
		if (image == null) {
			image = imageDescriptor.createImage();
			getCache().put(imageDescriptor, image);
		}
		return image;
	}

	/** Dispose all stored images
	 * 
	 */
	public void disposeAll() {
		for (Iterator<Image> it = getCache().values().iterator(); it.hasNext();) {
			Image image = it.next();
			image.dispose();
		}
		getCache().clear();
	}

	/** Get stored images
	 * @return
	 */
	private Map<OverlayImageDescriptor, Image> getCache() {
		return cache;
	}
}