org.netbeans.spi.debugger.ui

Interface EngineComponentsProvider

public interface EngineComponentsProvider

Provider of components associated with a debugger engine. An instance of this class needs to be registered under the appropriate session/engine ID path by DebuggerServiceRegistration.

The provided components are checked when the appropriate debugger engine is started and opened if necessary. After the debugger engine is finished, willCloseNotify(java.util.List) is called with components that are not used by other running engines and which are subsequently closed.

Since:

2.35

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EngineComponentsProvider.ComponentInfo Information about a component associated with a debugger engine.
static interface	EngineComponentsProvider.ComponentProvider
static class	EngineComponentsProvider.TopComponentProvider

Method Summary

Modifier and Type	Method and Description
List<EngineComponentsProvider.ComponentInfo>	getComponents() Provide a list of components associated with the debugger engine.
void	willCloseNotify(List<EngineComponentsProvider.ComponentInfo> components) This method is called when the debugger engine finishes with the list of components that are about to be closed.

Method Detail

getComponents

List<EngineComponentsProvider.ComponentInfo> getComponents()

Provide a list of components associated with the debugger engine. The components are opened when the debugger engine starts and closed when the debugger engine finishes.

Returns:

The list of components associated with the debugger engine.

willCloseNotify

void willCloseNotify(List<EngineComponentsProvider.ComponentInfo> components)

This method is called when the debugger engine finishes with the list of components that are about to be closed. The implementation might test them for opened state to decide if they should be opened the next time when getComponents() is called.

Parameters:

components - The components that are to be closed. It's guaranteed that only components returned by getComponents() are passed in and only those, that are not needed by another running engine.