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:

• access to the breakpoint manager
• access to the launch manager
• access to the expression manager
• access to the registered launcher extensions
• debug event notification
• status handlers

Clients may not instantiate or subclass this class.

Field Summary

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	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.
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.
void	startup() Starts up the debug plug-in.

Methods inherited from class org.eclipse.core.runtime.Plugin

find, find, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, 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

See Also:

Constant Field Values

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

See Also:

Constant Field Values

EXTENSION_POINT_BREAKPOINTS

public static final String EXTENSION_POINT_BREAKPOINTS

Simple identifier constant (value "breakpoints") for the breakpoints extension point.

Since:

2.0

See Also:

Constant Field Values

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

See Also:

Constant Field Values

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

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Status code indicating an unexpected internal error.

See Also:

Constant Field Values

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.

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

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

startup

public void startup()
             throws CoreException

Starts up the debug plug-in. This involves creating the launch and breakpoint managers, creating proxies to all launcher extensions, and restoring all persisted breakpoints.

This method is automatically invoked by the platform the first time any code in this plug-in is executed.

Clients must never explicitly call this method.

Overrides:

startup in class Plugin

Throws:

CoreException - if this plug-in fails to start up

See Also:

Plugin.startup()

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

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