org.eclipse.debug.ui.ILaunchShortcut2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.debug.ui Show documentation
This is org.eclipse.debug.ui jar used by Scout SDK
The newest version!
/*******************************************************************************
 * 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.debug.ui;

import org.eclipse.core.resources.IResource;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.ui.IEditorPart;


/**
 * 
 * An extension to a standard launch shortcut ({@link ILaunchShortcut}) allowing 
 * launch shortcuts to specify how selections and editors should be launched.
 * 
 * 
 * To launch a selection (or active editor), the debug platform derives a resource associated
 * with the selection (or active editor), and then resolves the most recently launched configuration
 * associated with that resource. This interface allows a launch shortcut to override the 
 * framework's resource and launch configuration resolution for selections (and active editors).
 * 
 * 
 * NOTE: the methods in this interface can be called in a non-UI thread.
 * 
 * 
 * Clients contributing a launch shortcut are intended to implement this interface.
 * 
 * @see org.eclipse.debug.internal.ui.contextlaunching.ContextRunner
 * @see org.eclipse.debug.internal.ui.contextlaunching.LaunchingResourceManager
 * @since 3.4
 */
public interface ILaunchShortcut2 extends ILaunchShortcut {

	/**
	 * Returns an array of  ILaunchConfigurations that apply to the specified
	 * selection, an empty collection if one could be created but does not exist, or
	 * null if default resource mappings should be used to derive associated
	 * configurations.  
	 * 
	 * @param selection the current selection
	 * @return an array of existing ILaunchConfigurations that could be 
	 *  used to launch the given selection, an empty array if one could be created
	 *  but does not exist, or null if default resource mappings should
	 *  be used to derive associated configurations
	 */
	public ILaunchConfiguration[] getLaunchConfigurations(ISelection selection);
	
	/**
	 * Returns an array of existing ILaunchConfigurations that could be 
	 * used to launch the given editor part, an empty array if one 
	 * could be created but does not exist, or null if default resource
	 * mappings should be used to derive associated configurations 
	 * 
	 * @param editorpart the current selection
	 * @return an array of existing ILaunchConfigurations that could be 
	 *  used to launch the given editor part/editor input, an empty array if one 
	 *  could be created but does not exist, or null if default resource
	 *  mappings should be used to derive associated configurations
	 */
	public ILaunchConfiguration[] getLaunchConfigurations(IEditorPart editorpart);
	
	/**
	 * Returns an IResource that maps to the given selection for launch
	 * purposes, or null if none. The resource is used to resolve a configuration
	 * to launch if this shortcut does not provide specific launch configurations to launch
	 * for the selection (via {@link #getLaunchConfigurations(ISelection)}. 
	 *  
	 * @param selection the current selection
	 * @return an IResource that maps to the given selection for launch
	 *  purposes or null if none
	 */
	public IResource getLaunchableResource(ISelection selection);
	
	/**
	 * Returns an IResource that maps to given editor part for launch
	 * purposes, or null if none. The resource is used to resolve a configuration
	 * to launch if this shortcut does not provide specific launch configurations to launch
	 * for the editor (via {@link #getLaunchConfigurations(IEditorPart)}.
	 * 
	 * @param editorpart the current editor part
	 * @return an IResource that maps to given editor part for launch
	 *  purposes, or null if none
	 */
	public IResource getLaunchableResource(IEditorPart editorpart);
}