Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.debugger/1 1.7.22
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package org.netbeans.spi.debugger

The NetBeans Debugger SPI definition defines interface to Debugger Plug-ins.

See:
Description

Interface Summary
ActionsProviderListener | `ActionsProvider` state listener.
ContextProvider | Abstract ancestor of classes providing lookup.

Class Summary
ActionsProvider | Represents implementation of one or more actions.
ActionsProviderSupport | Support for `ActionsProvider` implementation.
DebuggerEngineProvider | Creates a new instance of `DebuggerEngine` for session.
DelegatingDebuggerEngineProvider | Delegates support for some language to some existing `DebuggerEngine`.
DelegatingSessionProvider | Delegates `DebuggerInfo` support to some some existing `Session`.
SessionProvider | Creates a new instance of `Session` for some `DebuggerInfo`.

## Package org.netbeans.spi.debugger Description

The NetBeans Debugger SPI definition defines interface to Debugger Plug-ins. It allows to extend some already existing debugger, or create a new implementation of debugger.
Debugger SPI allows to:

- create a new instance of session: `SessionProvider`, `DelegatingSessionProvider`
- add support for a new language to some Session: `DebuggerEngineProvider`, `DelegatingDebuggerEngineProvider`
- install new watch evaluation engine: You can register a new evaluator for watches - `org.netbeans.spi.debugger.WatchesProvider` and `org.netbeans.spi.debugger.WatchImpl`.
- add a new actions: A support for some new debugger action (like Step Into Action) can be installed to some `DebuggerEngine` - `ActionsProvider`, `ActionsProviderSupport` and `ActionsProviderListener`.

## Registration

Debugger Core SPI contains service providers extending basic Debugger Core API model. Each service provider must be registerred in Meta-inf/debugger. Meta-inf/debugger is special folder in module *.jar file.
If you would like to register some implementation(s) of some service to some Debugger Core API interface of type {type name}, you should create file with name {service full class name}in folder Meta-inf/debugger/{type name}.
The file should contain a list of fully-qualified class names, one per line, of classes implementing the service interface. Space and tab characters surrounding each name, as well as blank lines, are ignored. The comment character is `'#'` (`\u0023`); on each line all characters following the first comment character are ignored. The file must be encoded in UTF-8.
Example:
I would like to register org.netbeans.modules.debugger.jpda.actions.StepAction and org.netbeans.modules.debugger.jpda.actions.StartAction service implementations for JPDA DebuggerEngine. In this case I should cerate file named org.netbeans.spi.debugger.ActionsProvider in folder Meta-inf/debugger/netbeans-JPDADebuggerEngine/. "netbeans-JPDADebuggerEngine" is a name of JPDA DebuggerEngine, and it can be obtained from DebuggerEngine.getTypeID(). This file should contain two lines:
org.netbeans.modules.debugger.jpda.actions.StepAction<EOL>
org.netbeans.modules.debugger.jpda.actions.StartAction <EOL>
List of all default service providers:

Service provider interface | Should be registerred to: | File names:
`SessionProvider` | `DebuggerInfo` | folder name: Meta-inf/debugger/{DebuggerInfo type name} file name: org.netbeans.spi.debugger.SessionProvider
`DelegatingSessionProvider` | `DebuggerInfo` | folder name: Meta-inf/debugger/{DebuggerInfo type name} file name: org.netbeans.spi.debugger.DelegatingSessionProvider
`DebuggerEngineProvider` | `Session` | folder name: Meta-inf/debugger/{Session type name} file name: org.netbeans.spi.debugger.DebuggerEngineProvider
`DelegatingDebuggerEngineProvider` | `Session` | folder name: Meta-inf/debugger/{Session type name} file name: org.netbeans.spi.debugger.DelegatingDebuggerEngineProvider
`org.netbeans.spi.debugger.WatchesProvider` | `DebuggerEngine` | folder name: Meta-inf/debugger/{DebuggerEngine type name} file name: org.netbeans.spi.debugger.WatchesProvider |
`ActionsProvider` | `DebuggerEngine` | folder name: Meta-inf/debugger/{DebuggerEngine type name} file name: org.netbeans.spi.debugger.ActionsProvider |

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.debugger/1 1.7.22
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

Built on December 7 2006. | Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.