org.eclipse.ui.internal.ISelectionConversionService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workbench Show documentation

This plug-in contains the bulk of the Workbench implementation, and depends on JFace, SWT, and Core Runtime. It cannot be used independently from org.eclipse.ui. Workbench client plug-ins should not depend directly on this plug-in.

The newest version!

/*******************************************************************************
 * Copyright (c) 2006 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.ui.internal;

import org.eclipse.jface.viewers.IStructuredSelection;

/**
 * 
 * A service that is capable of converting a selection into resources.
 * 
 * 
 * This interface is only intended for use within the
 * org.eclipse.ui.workbench and org.eclipse.ui.ide
 * plug-ins.
 * 
 * 
 * @since 3.2
 */
public interface ISelectionConversionService {

	/**
	 * Attempt to convert the elements in the passed selection into resources by
	 * asking each for its IResource property (iff it isn't already a resource).
	 * If all elements in the initial selection can be converted to resources
	 * then answer a new selection containing these resources; otherwise answer
	 * an empty selection.
	 * 
	 * @param originalSelection
	 *            the original selection; must not be null.
	 * @return the converted selection or an empty selection; never
	 *         null.
	 */
	public IStructuredSelection convertToResources(
			IStructuredSelection originalSelection);

}