Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> debug >> [ core overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.debug.core.ILaunchConfiguration JAVADOC | Sourc code of org.eclipse.debug.core.ILaunchConfiguration SOURCE | Download org.eclipse.debug.core.ILaunchConfiguration DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eclipse.debug.core
Interface ILaunchConfiguration  view ILaunchConfiguration download ILaunchConfiguration.java

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable
All Known Subinterfaces:
ILaunchConfigurationWorkingCopy
public interface ILaunchConfiguration
extends org.eclipse.core.runtime.IAdaptable

A launch configuration describes how to launch an application. Each launch configuration is an instance of a type of launch configuration as described by a launch configuration type extension. Each launch configuration has a launch configuration delegate which performs the actual launching of a configuration.

A launch configuration may be shared in a repository via standard VCM mechanisms, or may be stored locally, essentially making the launch configuration private for a single user. Thus, a launch configuration may stored as a file in the workspace (shared), or as a file in the debug plug-in's state location.

A launch configuration is a handle to its underlying storage.

A launch configuration is modified by obtaining a working copy of a launch configuration, modifying the working copy, and then saving the working copy.

This interface is not intended to be implemented by clients. Clients that define a launch configuration delegate extension implement the ILaunchConfigurationDelegate interface.

Since:
2.0

Field Summary
static java.lang.String ATTR_SOURCE_LOCATOR_ID
          Launch configuration attribute storing an identifier of a persistable source locator extension.
static java.lang.String ATTR_SOURCE_LOCATOR_MEMENTO
          Launch configuration attribute storing a memento of a source locator.
static java.lang.String LAUNCH_CONFIGURATION_FILE_EXTENSION
          The file extension for launch configuration files (value "launch").
 
Method Summary
 boolean contentsEqual(ILaunchConfiguration configuration)
          Returns whether the contents of this launch configuration are equal to the contents of the given launch configuration.
 ILaunchConfigurationWorkingCopy copy(java.lang.String name)
          Returns a copy of this launch configuration, as a working copy, with the specified name.
 void delete()
          Deletes this launch configuration.
 boolean exists()
          Returns whether this launch configuration's underlying storage exists.
 boolean getAttribute(java.lang.String attributeName, boolean defaultValue)
          Returns the boolean-valued attribute with the given name.
 int getAttribute(java.lang.String attributeName, int defaultValue)
          Returns the integer-valued attribute with the given name.
 java.util.List getAttribute(java.lang.String attributeName, java.util.List defaultValue)
          Returns the java.util.List-valued attribute with the given name.
 java.util.Map getAttribute(java.lang.String attributeName, java.util.Map defaultValue)
          Returns the java.util.Map-valued attribute with the given name.
 java.lang.String getAttribute(java.lang.String attributeName, java.lang.String defaultValue)
          Returns the string-valued attribute with the given name.
 java.util.Map getAttributes()
          Returns a map containing the attributes in this launch configuration.
 java.lang.String getCategory()
          Returns this launch configuration's type's category, or null if unspecified.
 org.eclipse.core.resources.IFile getFile()
          Returns the file this launch configuration is stored in, or null if this configuration is stored locally with the workspace.
 org.eclipse.core.runtime.IPath getLocation()
          Returns the location of this launch configuration as a path.
 java.lang.String getMemento()
          Returns a memento for this launch configuration, or null if unable to generate a memento for this configuration.
 java.lang.String getName()
          Returns the name of this launch configuration.
 ILaunchConfigurationType getType()
          Returns the type of this launch configuration.
 ILaunchConfigurationWorkingCopy getWorkingCopy()
          Returns a working copy of this launch configuration.
 boolean isLocal()
          Returns whether this launch configuration is stored locally with the workspace.
 boolean isWorkingCopy()
          Returns whether this launch configuration is a working copy.
 ILaunch launch(java.lang.String mode, org.eclipse.core.runtime.IProgressMonitor monitor)
          Launches this configuration in the specified mode by delegating to this configuration's launch configuration delegate, and returns the resulting launch.
 ILaunch launch(java.lang.String mode, org.eclipse.core.runtime.IProgressMonitor monitor, boolean build)
          Launches this configuration in the specified mode by delegating to this configuration's launch configuration delegate, and returns the resulting launch.
 boolean supportsMode(java.lang.String mode)
          Returns whether this launch configuration supports the specified mode.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

LAUNCH_CONFIGURATION_FILE_EXTENSION

public static final java.lang.String LAUNCH_CONFIGURATION_FILE_EXTENSION
The file extension for launch configuration files (value "launch").

See Also:
Constant Field Values

ATTR_SOURCE_LOCATOR_ID

public static final java.lang.String ATTR_SOURCE_LOCATOR_ID
Launch configuration attribute storing an identifier of a persistable source locator extension. When this attribute is specified, a new source locator will be created automatically and associated with the launch for this configuration.

See Also:
org.eclipse.debug.core.model.IPersistableSourceLocator

ATTR_SOURCE_LOCATOR_MEMENTO

public static final java.lang.String ATTR_SOURCE_LOCATOR_MEMENTO
Launch configuration attribute storing a memento of a source locator. When this attribute is specified in conjunction with a source locator id, the source locator created for a launch will be initialized with this memento. When not specified, but a source locator id is specified, the source locator will be initialized to default values.

See Also:
org.eclipse.debug.core.model.IPersistableSourceLocator
Method Detail

launch

public ILaunch launch(java.lang.String mode,
                      org.eclipse.core.runtime.IProgressMonitor monitor)
               throws org.eclipse.core.runtime.CoreException
Launches this configuration in the specified mode by delegating to this configuration's launch configuration delegate, and returns the resulting launch.

Equivalent to calling launch(String, IProgressMontitor, boolean) with a build flag of false.

launch

public ILaunch launch(java.lang.String mode,
                      org.eclipse.core.runtime.IProgressMonitor monitor,
                      boolean build)
               throws org.eclipse.core.runtime.CoreException
Launches this configuration in the specified mode by delegating to this configuration's launch configuration delegate, and returns the resulting launch.

If this configuration's launch delegate implements ILaunchConfigurationDelegate2, the launch delegate will be consulted to provide a launch object for the launch, perform pre-launch checks, and build before the launch. If build is true and the associated launch delegate does not implement ILaunchConfigurationDelegate2 an incremental workspace build will be performed before the launch by the debug platform. The resulting launch object is registered with the launch manager before passing it to this configuration's delegate launch method, for contributions (debug targets and processes).

If the delegate contributes a source locator to the launch, that source locator is used. Otherwise an appropriate source locator is contributed to the launch based on the values of ATTR_SOURCE_LOCATOR_ID and ATTR_SOURCE_LOCATOR_MEMENTO. If the launch is cancelled (via the given progress monitor), the launch is removed from the launch manager. The launch is returned whether cancelled or not. Invoking this method causes the underlying launch configuration delegate to be instantiated (if not already).

Since:
3.0

supportsMode

public boolean supportsMode(java.lang.String mode)
                     throws org.eclipse.core.runtime.CoreException
Returns whether this launch configuration supports the specified mode.

getName

public java.lang.String getName()
Returns the name of this launch configuration.

getLocation

public org.eclipse.core.runtime.IPath getLocation()
Returns the location of this launch configuration as a path.

exists

public boolean exists()
Returns whether this launch configuration's underlying storage exists.

getAttribute

public int getAttribute(java.lang.String attributeName,
                        int defaultValue)
                 throws org.eclipse.core.runtime.CoreException
Returns the integer-valued attribute with the given name. Returns the given default value if the attribute is undefined.

getAttribute

public java.lang.String getAttribute(java.lang.String attributeName,
                                     java.lang.String defaultValue)
                              throws org.eclipse.core.runtime.CoreException
Returns the string-valued attribute with the given name. Returns the given default value if the attribute is undefined.

getAttribute

public boolean getAttribute(java.lang.String attributeName,
                            boolean defaultValue)
                     throws org.eclipse.core.runtime.CoreException
Returns the boolean-valued attribute with the given name. Returns the given default value if the attribute is undefined.

getAttribute

public java.util.List getAttribute(java.lang.String attributeName,
                                   java.util.List defaultValue)
                            throws org.eclipse.core.runtime.CoreException
Returns the java.util.List-valued attribute with the given name. Returns the given default value if the attribute is undefined.

getAttribute

public java.util.Map getAttribute(java.lang.String attributeName,
                                  java.util.Map defaultValue)
                           throws org.eclipse.core.runtime.CoreException
Returns the java.util.Map-valued attribute with the given name. Returns the given default value if the attribute is undefined.

getFile

public org.eclipse.core.resources.IFile getFile()
Returns the file this launch configuration is stored in, or null if this configuration is stored locally with the workspace.

getType

public ILaunchConfigurationType getType()
                                 throws org.eclipse.core.runtime.CoreException
Returns the type of this launch configuration.

isLocal

public boolean isLocal()
Returns whether this launch configuration is stored locally with the workspace.

getWorkingCopy

public ILaunchConfigurationWorkingCopy getWorkingCopy()
                                               throws org.eclipse.core.runtime.CoreException
Returns a working copy of this launch configuration. Changes to the working copy will be applied to this launch configuration when saved. The working copy will refer to this launch configuration as its original launch configuration.

copy

public ILaunchConfigurationWorkingCopy copy(java.lang.String name)
                                     throws org.eclipse.core.runtime.CoreException
Returns a copy of this launch configuration, as a working copy, with the specified name. The new working copy does not refer back to this configuration as its original launch configuration (the working copy will return null for getOriginal()). When the working copy is saved it will not effect this launch configuration.

isWorkingCopy

public boolean isWorkingCopy()
Returns whether this launch configuration is a working copy. Launch configurations which return true to this method can be safely cast to org.eclipse.debug.core.ILaunchConfigurationWorkingCopy

delete

public void delete()
            throws org.eclipse.core.runtime.CoreException
Deletes this launch configuration. This configuration's underlying storage is deleted. Has no effect if this configuration does not exist.

getMemento

public java.lang.String getMemento()
                            throws org.eclipse.core.runtime.CoreException
Returns a memento for this launch configuration, or null if unable to generate a memento for this configuration. A memento can be used to re-create a launch configuration, via the launch manager.

contentsEqual

public boolean contentsEqual(ILaunchConfiguration configuration)
Returns whether the contents of this launch configuration are equal to the contents of the given launch configuration.

getCategory

public java.lang.String getCategory()
                             throws org.eclipse.core.runtime.CoreException
Returns this launch configuration's type's category, or null if unspecified.

Since:
2.1

getAttributes

public java.util.Map getAttributes()
                            throws org.eclipse.core.runtime.CoreException
Returns a map containing the attributes in this launch configuration. Returns an empty map if this configuration has no attributes.

Since:
2.1
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> debug >> [ core overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.debug.core.ILaunchConfiguration JAVADOC | Sourc code of org.eclipse.debug.core.ILaunchConfiguration SOURCE | Download org.eclipse.debug.core.ILaunchConfiguration DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD