Eclipse Platform
2.1

org.eclipse.debug.core
Class DebugPlugin

java.lang.Object
  |
  +--org.eclipse.core.runtime.Plugin
        |
        +--org.eclipse.debug.core.DebugPlugin

public class DebugPlugin
extends Plugin

There is one instance of the debug plug-in available from DebugPlugin.getDefault(). The debug plug-in provides:

Clients may not instantiate or subclass this class.


Field Summary
static int ERR_WORKING_DIRECTORY_NOT_SUPPORTED
          Status code indicating that the Eclipse runtime does not support launching a program with a working directory.
static String EXTENSION_POINT_BREAKPOINTS
          Simple identifier constant (value "breakpoints") for the breakpoints extension point.
static String EXTENSION_POINT_LAUNCH_CONFIGURATION_COMPARATORS
          Simple identifier constant (value "launchConfigurationComparators") for the launch configuration comparators extension point.
static String EXTENSION_POINT_LAUNCH_CONFIGURATION_TYPES
          Simple identifier constant (value "launchConfigurationTypes") for the launch configuration types extension point.
static String EXTENSION_POINT_SOURCE_LOCATORS
          Simple identifier constant (value "sourceLocators") for the source locators extension point.
static String EXTENSION_POINT_STATUS_HANDLERS
          Simple identifier constant (value "statusHandlers") for the status handlers extension point.
static int INTERNAL_ERROR
          Status code indicating an unexpected internal error.
 
Fields inherited from class org.eclipse.core.runtime.Plugin
PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME
 
Constructor Summary
DebugPlugin(IPluginDescriptor descriptor)
          Constructs the debug plug-in.
 
Method Summary
 void addDebugEventFilter(IDebugEventFilter filter)
          Adds the given debug event filter to the registered event filters.
 void addDebugEventListener(IDebugEventSetListener listener)
          Adds the given listener to the collection of registered debug event listeners.
 void asyncExec(Runnable r)
          Asynchronously executes the given runnable in a seperate thread, after debug event dispatch has completed.
static Process exec(String[] cmdLine, File workingDirectory)
          Convenience method that performs a runtime exec on the given command line in the context of the specified working directory, and returns the resulting process.
 void fireDebugEventSet(DebugEvent[] events)
          Notifies all registered debug event set listeners of the given debug events.
 IBreakpointManager getBreakpointManager()
          Returns the breakpoint manager.
static DebugPlugin getDefault()
          Returns the singleton instance of the debug plug-in.
 IExpressionManager getExpressionManager()
          Returns the expression manager.
 ILaunchManager getLaunchManager()
          Returns the launch manager.
 IStatusHandler getStatusHandler(IStatus status)
          Returns the status handler registered for the given status, or null if none.
static String getUniqueIdentifier()
          Convenience method which returns the unique identifier of this plugin.
static void log(IStatus status)
          Logs the specified status with this plug-in's log.
static void log(Throwable t)
          Logs the specified throwable with this plug-in's log.
static void logDebugMessage(String message)
          Logs the given message if in debug mode.
static IProcess newProcess(ILaunch launch, Process process, String label)
          Creates and returns a new process representing the given java.lang.Process.
static IProcess newProcess(ILaunch launch, Process process, String label, Map attributes)
          Creates and returns a new process representing the given java.lang.Process.
 void removeDebugEventFilter(IDebugEventFilter filter)
          Removes the given debug event filter from the registered event filters.
 void removeDebugEventListener(IDebugEventSetListener listener)
          Removes the given listener from the collection of registered debug event listeners.
 void shutdown()
          Shuts down this debug plug-in and discards all plug-in state.
 
Methods inherited from class org.eclipse.core.runtime.Plugin
find, find, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, startup, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EXTENSION_POINT_LAUNCH_CONFIGURATION_TYPES

public static final String EXTENSION_POINT_LAUNCH_CONFIGURATION_TYPES
Simple identifier constant (value "launchConfigurationTypes") for the launch configuration types extension point.
Since:
2.0

EXTENSION_POINT_LAUNCH_CONFIGURATION_COMPARATORS

public static final String EXTENSION_POINT_LAUNCH_CONFIGURATION_COMPARATORS
Simple identifier constant (value "launchConfigurationComparators") for the launch configuration comparators extension point.
Since:
2.0

EXTENSION_POINT_BREAKPOINTS

public static final String EXTENSION_POINT_BREAKPOINTS
Simple identifier constant (value "breakpoints") for the breakpoints extension point.
Since:
2.0

EXTENSION_POINT_STATUS_HANDLERS

public static final String EXTENSION_POINT_STATUS_HANDLERS
Simple identifier constant (value "statusHandlers") for the status handlers extension point.
Since:
2.0

EXTENSION_POINT_SOURCE_LOCATORS

public static final String EXTENSION_POINT_SOURCE_LOCATORS
Simple identifier constant (value "sourceLocators") for the source locators extension point.
Since:
2.0

INTERNAL_ERROR

public static final int INTERNAL_ERROR
Status code indicating an unexpected internal error.

ERR_WORKING_DIRECTORY_NOT_SUPPORTED

public static final int ERR_WORKING_DIRECTORY_NOT_SUPPORTED
Status code indicating that the Eclipse runtime does not support launching a program with a working directory. This feature is only available if Eclipse is run on a 1.3 runtime or higher.

A status handler may be registered for this error condition, and should return a Boolean indicating whether the program should be relaunched with the default working directory.

Constructor Detail

DebugPlugin

public DebugPlugin(IPluginDescriptor descriptor)
Constructs the debug plug-in.

An instance of this plug-in runtime class is automatically created when the facilities provided by this plug-in are required. Clients must never explicitly instantiate a plug-in runtime class.

Parameters:
pluginDescriptor - the plug-in descriptor for the debug plug-in
Method Detail

getDefault

public static DebugPlugin getDefault()
Returns the singleton instance of the debug plug-in.

getUniqueIdentifier

public static String getUniqueIdentifier()
Convenience method which returns the unique identifier of this plugin.

addDebugEventListener

public void addDebugEventListener(IDebugEventSetListener listener)
Adds the given listener to the collection of registered debug event listeners. Has no effect if an identical listener is already registered.
Parameters:
listener - the listener to add
Since:
2.0

fireDebugEventSet

public void fireDebugEventSet(DebugEvent[] events)
Notifies all registered debug event set listeners of the given debug events. Events which are filtered by a registered debug event filter are not fired.
Parameters:
events - array of debug events to fire
Since:
2.0
See Also:
IDebugEventFilter, IDebugEventSetListener

asyncExec

public void asyncExec(Runnable r)
Asynchronously executes the given runnable in a seperate thread, after debug event dispatch has completed. If debug events are not currently being dispatched, the runnable is scheduled to run in a seperate thread immediately.
Parameters:
r - runnable to execute asynchronously
Since:
2.1

getBreakpointManager

public IBreakpointManager getBreakpointManager()
Returns the breakpoint manager.
Returns:
the breakpoint manager
See Also:
IBreakpointManager

getLaunchManager

public ILaunchManager getLaunchManager()
Returns the launch manager.
Returns:
the launch manager
See Also:
ILaunchManager

getStatusHandler

public IStatusHandler getStatusHandler(IStatus status)
Returns the status handler registered for the given status, or null if none.
Returns:
the status handler registered for the given status, or null if none
Since:
2.0

getExpressionManager

public IExpressionManager getExpressionManager()
Returns the expression manager.
Returns:
the expression manager
Since:
2.0
See Also:
IExpressionManager

removeDebugEventListener

public void removeDebugEventListener(IDebugEventSetListener listener)
Removes the given listener from the collection of registered debug event listeners. Has no effect if an identical listener is not already registered.
Parameters:
listener - the listener to remove
Since:
2.0

shutdown

public void shutdown()
              throws CoreException
Shuts down this debug plug-in and discards all plug-in state.

This method will be automatically invoked by the platform when the platform is shut down.

Clients must never explicitly call this method.
Overrides:
shutdown in class Plugin
Throws:
CoreException - if this plug-in fails to shut down

newProcess

public static IProcess newProcess(ILaunch launch,
                                  Process process,
                                  String label)
Creates and returns a new process representing the given java.lang.Process. A streams proxy is created for the I/O streams in the system process. The process is added to the given launch.
Parameters:
launch - the launch the process is conatined in
process - the system process to wrap
label - the label assigned to the process
Returns:
the process
See Also:
IProcess

newProcess

public static IProcess newProcess(ILaunch launch,
                                  Process process,
                                  String label,
                                  Map attributes)
Creates and returns a new process representing the given java.lang.Process. A streams proxy is created for the I/O streams in the system process. The process is added to the given launch, and the process is initialized with the given attribute map.
Parameters:
launch - the launch the process is conatined in
process - the system process to wrap
label - the label assigned to the process
initial - values for the attribute map
Returns:
the process
Since:
2.1
See Also:
IProcess

exec

public static Process exec(String[] cmdLine,
                           File workingDirectory)
                    throws CoreException
Convenience method that performs a runtime exec on the given command line in the context of the specified working directory, and returns the resulting process. If the current runtime does not support the specification of a working directory, the status handler for error code ERR_WORKING_DIRECTORY_NOT_SUPPORTED is queried to see if the exec should be re-executed without specifying a working directory.
Parameters:
cmdLine - the command line
workingDirectory - the working directory, or null
Returns:
the resulting process or null if the exec is cancelled
Since:
2.1
See Also:
Runtime

addDebugEventFilter

public void addDebugEventFilter(IDebugEventFilter filter)
Adds the given debug event filter to the registered event filters. Has no effect if an identical filter is already registerd.
Parameters:
filter - debug event filter
Since:
2.0

removeDebugEventFilter

public void removeDebugEventFilter(IDebugEventFilter filter)
Removes the given debug event filter from the registered event filters. Has no effect if an identical filter is not already registered.
Parameters:
filter - debug event filter
Since:
2.0

logDebugMessage

public static void logDebugMessage(String message)
Logs the given message if in debug mode.
Parameters:
message - the message to log
Since:
2.0

log

public static void log(IStatus status)
Logs the specified status with this plug-in's log.
Parameters:
status - status to log
Since:
2.0

log

public static void log(Throwable t)
Logs the specified throwable with this plug-in's log.
Parameters:
t - throwable to log
Since:
2.0

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.