|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.Plugin
org.eclipse.debug.core.DebugPlugin
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 String |
ATTR_CAPTURE_OUTPUT
The launch attribute that designates whether or not it's associated launch should capture output. |
static String |
ATTR_PROCESS_FACTORY_ID
The launch configuration attribute that designates the process factory ID for the process factory to be used when creating a new process as a result of launching the launch configuration. |
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_LAUNCH_DELEGATES
Simple identifier constant (value "launchDelegates" ) for the
launch delegates extension point. |
static String |
EXTENSION_POINT_LAUNCH_MODES
Simple identifier constant (value "launchModes" ) for the
source modes extension point. |
static String |
EXTENSION_POINT_LOGICAL_STRUCTURE_PROVIDERS
Simple identifier constant (value "logicalStructureProviders" ) for the
logical structure types extension point. |
static String |
EXTENSION_POINT_LOGICAL_STRUCTURE_TYPES
Simple identifier constant (value "logicalStructureTypes" ) for the
logical structure types extension point. |
static String |
EXTENSION_POINT_PROCESS_FACTORIES
Simple identifier constant (value "processFactories" ) for the
process factories extension point. |
static String |
EXTENSION_POINT_SOURCE_CONTAINER_TYPES
Simple identifier constant (value "sourceContainerTypes" ) for the
source container types extension point. |
static String |
EXTENSION_POINT_SOURCE_LOCATORS
Simple identifier constant (value "sourceLocators" ) for the
source locators extension point. |
static String |
EXTENSION_POINT_SOURCE_PATH_COMPUTERS
Simple identifier constant (value "sourcePathComputers" ) for the
source path computers 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 |
---|
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME |
Constructor Summary | |
---|---|
DebugPlugin()
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. |
static Process |
exec(String[] cmdLine,
File workingDirectory,
String[] envp)
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. |
static ILogicalStructureType |
getDefaultStructureType(ILogicalStructureType[] types)
Returns the default logical structure type among the given combination of logical structure types, or null if none. |
IExpressionManager |
getExpressionManager()
Returns the expression manager. |
ILaunchManager |
getLaunchManager()
Returns the launch manager. |
static ILogicalStructureType[] |
getLogicalStructureTypes(IValue value)
Returns any logical structure types that have been contributed for the given value. |
IMemoryBlockManager |
getMemoryBlockManager()
Returns the memory block 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 void |
logMessage(String message,
Throwable throwable)
Logs the given message with this plug-in's log and the given throwable or null if none. |
static Document |
newDocument()
Creates and returns a new XML document. |
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 . |
static String[] |
parseArguments(String args)
Prarses the given command line into seperate arguments that can be passed to DebugPlugin.exec(String[], File) . |
static Element |
parseDocument(String document)
Parses the given string representing an XML document, returning its root element. |
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. |
static String |
serializeDocument(Document document)
Serializes the given XML document into a string. |
static void |
setDefaultStructureType(ILogicalStructureType[] types,
ILogicalStructureType def)
Sets the default logical structure type among the given combination of logical structure types. |
void |
stop(BundleContext context)
Stops this plug-in. |
Methods inherited from class org.eclipse.core.runtime.Plugin |
---|
find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, shutdown, start, startup, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String EXTENSION_POINT_LAUNCH_CONFIGURATION_TYPES
"launchConfigurationTypes"
)
for the launch configuration types extension point.
public static final String EXTENSION_POINT_LAUNCH_CONFIGURATION_COMPARATORS
"launchConfigurationComparators"
)
for the launch configuration comparators extension point.
public static final String EXTENSION_POINT_BREAKPOINTS
"breakpoints"
) for the
breakpoints extension point.
public static final String EXTENSION_POINT_STATUS_HANDLERS
"statusHandlers"
) for the
status handlers extension point.
public static final String EXTENSION_POINT_SOURCE_LOCATORS
"sourceLocators"
) for the
source locators extension point.
public static final String EXTENSION_POINT_LAUNCH_MODES
"launchModes"
) for the
source modes extension point.
public static final String EXTENSION_POINT_LAUNCH_DELEGATES
"launchDelegates"
) for the
launch delegates extension point.
public static final String EXTENSION_POINT_PROCESS_FACTORIES
"processFactories"
) for the
process factories extension point.
public static final String EXTENSION_POINT_LOGICAL_STRUCTURE_TYPES
"logicalStructureTypes"
) for the
logical structure types extension point.
public static final String EXTENSION_POINT_LOGICAL_STRUCTURE_PROVIDERS
"logicalStructureProviders"
) for the
logical structure types extension point.
public static final String EXTENSION_POINT_SOURCE_CONTAINER_TYPES
"sourceContainerTypes"
) for the
source container types extension point.
public static final String EXTENSION_POINT_SOURCE_PATH_COMPUTERS
"sourcePathComputers"
) for the
source path computers extension point.
public static final int INTERNAL_ERROR
public static final int ERR_WORKING_DIRECTORY_NOT_SUPPORTED
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.
public static final String ATTR_PROCESS_FACTORY_ID
public static final String ATTR_CAPTURE_OUTPUT
true
or false
. When unspecififed, the default
value is considered true
.
Constructor Detail |
public DebugPlugin()
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 |
public static DebugPlugin getDefault()
public static String getUniqueIdentifier()
public void addDebugEventListener(IDebugEventSetListener listener)
listener
- the listener to addpublic void fireDebugEventSet(DebugEvent[] events)
events
- array of debug events to fireIDebugEventFilter
,
IDebugEventSetListener
public void asyncExec(Runnable r)
r
- runnable to execute asynchronouslypublic IBreakpointManager getBreakpointManager()
IBreakpointManager
public ILaunchManager getLaunchManager()
ILaunchManager
public IMemoryBlockManager getMemoryBlockManager()
IMemoryBlockManager
public IStatusHandler getStatusHandler(IStatus status)
null
if none.
null
if nonepublic IExpressionManager getExpressionManager()
IExpressionManager
public void removeDebugEventListener(IDebugEventSetListener listener)
listener
- the listener to removepublic void stop(BundleContext context) throws Exception
Plugin
This method should be re-implemented in subclasses that need to do something when the plug-in is shut down. Implementors should call the inherited method as late as possible to ensure that any system requirements can be met.
Plug-in shutdown code should be robust. In particular, this method should always make an effort to shut down the plug-in. Furthermore, the code should not assume that the plug-in was started successfully, as this method will be invoked in the event of a failure during startup.
Note 1: If a plug-in has been automatically started, this method will be automatically invoked by the platform when the platform is shut down.
Note 2: This method is intended to perform simple termination of the plug-in environment. The platform may terminate invocations that do not complete in a timely fashion.
Note 3: The supplied bundle context represents the plug-in to the OSGi framework. For security reasons, it is strongly recommended that this object should not be divulged.
Clients must never explicitly call this method.
stop
in interface BundleActivator
stop
in class Plugin
context
- the bundle context for this plug-in
Exception
- if this method fails to shut down this plug-inpublic static IProcess newProcess(ILaunch launch, Process process, String label)
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.
If the launch configuration associated with the given launch specifies a process factory, it will be used to instantiate the new process.
launch
- the launch the process is contained inprocess
- the system process to wraplabel
- the label assigned to the process
IProcess
,
IProcessFactory
public static IProcess newProcess(ILaunch launch, Process process, String label, Map attributes)
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.
If the launch configuration associated with the given launch specifies a process factory, it will be used to instantiate the new process.
launch
- the launch the process is contained inprocess
- the system process to wraplabel
- the label assigned to the processattributes
- initial values for the attribute map
null
can be returned if errors occur dealing with the process factory
designated to create the process.IProcess
,
IProcessFactory
public static ILogicalStructureType[] getLogicalStructureTypes(IValue value)
value
- the value for which logical structure types have been requested
public static ILogicalStructureType getDefaultStructureType(ILogicalStructureType[] types)
null
if none. When the given combination
of logical structure type is applicable for a value, the default logical structure
type is used to display a value.
types
- a combination of structures applicable to a value
null
if nonepublic static void setDefaultStructureType(ILogicalStructureType[] types, ILogicalStructureType def)
null
indicates there is no default logical stucture
for the given combination of types.
types
- a combination of logical structure types applicable to a valuedef
- the default logical structure among the given combination of types
or null
if nonepublic static Process exec(String[] cmdLine, File workingDirectory) throws CoreException
ERR_WORKING_DIRECTORY_NOT_SUPPORTED
is queried to see if the
exec should be re-executed without specifying a working directory.
cmdLine
- the command lineworkingDirectory
- the working directory, or null
null
if the exec is
cancelled
CoreException
Runtime
public static Process exec(String[] cmdLine, File workingDirectory, String[] envp) throws CoreException
ERR_WORKING_DIRECTORY_NOT_SUPPORTED
is queried to see if the
exec should be re-executed without specifying a working directory.
cmdLine
- the command lineworkingDirectory
- the working directory, or null
envp
- the environment variables set in the process, or null
null
if the exec is
cancelled
CoreException
Runtime
public void addDebugEventFilter(IDebugEventFilter filter)
filter
- debug event filterpublic void removeDebugEventFilter(IDebugEventFilter filter)
filter
- debug event filterpublic static void logDebugMessage(String message)
message
- the message to logpublic static void logMessage(String message, Throwable throwable)
null
if none.
message
- the message to logthrowable
- the exception that occurred or null
if nonepublic static void log(IStatus status)
status
- status to logpublic static void log(Throwable t)
t
- throwable to logpublic static Document newDocument() throws CoreException
CoreException
- if unable to create a new documentpublic static String serializeDocument(Document document) throws CoreException
document
- XML document to serialize
CoreException
- if unable to serialize the documentpublic static Element parseDocument(String document) throws CoreException
document
- XML document as a string
CoreException
- if unable to parse the documentpublic static String[] parseArguments(String args)
DebugPlugin.exec(String[], File)
. Embedded quotes and slashes
are escaped.
args
- command line arguments as a single string
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.