DebuggerManager (Debugger Core API)

java.lang.Object
- org.netbeans.api.debugger.DebuggerManager

All Implemented Interfaces:: ContextProvider

public final class DebuggerManager
extends Object
implements ContextProvider

The root class of Debugger APIs. DebuggerManager manages list of Sessions, Breakpoints and Watches.

Description
Functionality	Start & finish debugging: DebuggerManager manages a process of starting a new debugging ( `DebuggerManager.startDebugging(org.netbeans.api.debugger.DebuggerInfo)`). It cooperates with all installed `DebuggerEngineProvider`s to create a new `Session` (or Sessions) and a new `DebuggerEngine` (or Engines). It supports kill all sessions too (`DebuggerManager.finishAllSessions()`). Sessions management: DebuggerManager keeps list of all `Session`s (`DebuggerManager.getSessions()`), and manages current session (`DebuggerManager.getCurrentSession()`, `DebuggerManager.setCurrentSession(org.netbeans.api.debugger.Session)`). Engine management: DebuggerManager provides current engine (`DebuggerManager.getCurrentEngine()`). Current engine is derivated from current session. So, debuggerManager.getCurrentEngine () == debuggerManager. getCurrentSession.getCurrentEngine () should be always true. Breakpoints management: DebuggerManager keeps list of all shared breakpoints (`DebuggerManager.getBreakpoints()`). Breakpoint can be added (`DebuggerManager.addBreakpoint(org.netbeans.api.debugger.Breakpoint)`) and removed (`DebuggerManager.removeBreakpoint(org.netbeans.api.debugger.Breakpoint)`). Watches management: DebuggerManager keeps list of all shared watches (`DebuggerManager.getWatches()`). Watch can be created & added (`DebuggerManager.createWatch(java.lang.String)`). Support for listening: DebuggerManager propagates all changes to two type of listeners - general `PropertyChangeListener` and specific `DebuggerManagerListener`.
Clinents / Providers	DebuggerCore module should be the only one provider of this abstract class. This class should be called from debugger plug-in modules and from debugger UI modules.
Lifecycle	The only one instance of DebuggerManager should exist, and it should be created in `DebuggerManager.getDebuggerManager()` method.
Evolution	No method should be removed from this class, but some functionality can be added.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_BREAKPOINTS` Name of property for the set of breakpoints in the system.
`static String`	`PROP_BREAKPOINTS_INIT` Name of property for the set of breakpoints in the system.
`static String`	`PROP_CURRENT_ENGINE` Name of property for current debugger engine.
`static String`	`PROP_CURRENT_SESSION` Name of property for current debugger session.
`static String`	`PROP_DEBUGGER_ENGINES` Name of property for set of running debugger engines.
`static String`	`PROP_SESSIONS` Name of property for set of running debugger sessions.
`static String`	`PROP_WATCHES` Name of property for the set of watches in the system.
`static String`	`PROP_WATCHES_INIT` Name of property for the set of watches in the system.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBreakpoint(Breakpoint breakpoint)` Adds a new breakpoint.
`void`	`addDebuggerListener(DebuggerManagerListener l)` This listener notificates about changes of breakpoints, watches and threads.
`void`	`addDebuggerListener(String propertyName, DebuggerManagerListener l)` Add a debuggerManager listener to changes of watches and breakpoints.
`Watch`	`createPinnedWatch(String expr, Watch.Pin pin)` Create a watch pinned at the specified pin location.
`Watch`	`createWatch(int index, String expr)` Creates a watch with its expression set to an initial value and add it at the specific position
`Watch`	`createWatch(String expr)` Creates a watch with its expression set to an initial value.
`void`	`finishAllSessions()` Kills all `Session`s and `DebuggerEngine`s.
`ActionsManager`	`getActionsManager()`
`Breakpoint[]`	`getBreakpoints()` Gets all registered breakpoints.
`DebuggerEngine`	`getCurrentEngine()` Returns current debugger engine or `null`.
`Session`	`getCurrentSession()` Returns current debugger session or `null`.
`DebuggerEngine[]`	`getDebuggerEngines()` Returns set of running debugger engines.
`static DebuggerManager`	`getDebuggerManager()` Returns default instance of DebuggerManager.
`Session[]`	`getSessions()` Returns set of running debugger sessions.
`Watch[]`	`getWatches()` Gets all shared watches in the system.
`static ContextProvider`	`join(ContextProvider cp1, ContextProvider cp2)` Join two lookups together.
`<T> List<? extends T>`	`lookup(String folder, Class<T> service)` Returns list of services of given type from given folder.
`<T> T`	`lookupFirst(String folder, Class<T> service)` Returns one service of given type from given folder.
`void`	`removeAllWatches()` Removes all watches from the system.
`void`	`removeBreakpoint(Breakpoint breakpoint)` Removes breakpoint.
`void`	`removeDebuggerListener(DebuggerManagerListener l)` Removes debugger listener.
`void`	`removeDebuggerListener(String propertyName, DebuggerManagerListener l)` Remove a debuggerManager listener to changes of watches and breakpoints.
`void`	`reorderWatches(int[] permutation)` Reorders watches with given permutation.
`void`	`setCurrentSession(Session session)` Sets current debugger session.
`DebuggerEngine[]`	`startDebugging(DebuggerInfo info)` Start a new debugging for given `DebuggerInfo`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_BREAKPOINTS_INIT
```
public static final String PROP_BREAKPOINTS_INIT
```
    Name of property for the set of breakpoints in the system.
    
    See Also:
    
    Constant Field Values
  - PROP_BREAKPOINTS
```
public static final String PROP_BREAKPOINTS
```
    Name of property for the set of breakpoints in the system.
    
    See Also:
    
    Constant Field Values
  - PROP_CURRENT_ENGINE
```
public static final String PROP_CURRENT_ENGINE
```
    Name of property for current debugger engine.
    
    See Also:
    
    Constant Field Values
  - PROP_CURRENT_SESSION
```
public static final String PROP_CURRENT_SESSION
```
    Name of property for current debugger session.
    
    See Also:
    
    Constant Field Values
  - PROP_SESSIONS
```
public static final String PROP_SESSIONS
```
    Name of property for set of running debugger sessions.
    
    See Also:
    
    Constant Field Values
  - PROP_DEBUGGER_ENGINES
```
public static final String PROP_DEBUGGER_ENGINES
```
    Name of property for set of running debugger engines.
    
    See Also:
    
    Constant Field Values
  - PROP_WATCHES
```
public static final String PROP_WATCHES
```
    Name of property for the set of watches in the system.
    
    See Also:
    
    Constant Field Values
  - PROP_WATCHES_INIT
```
public static final String PROP_WATCHES_INIT
```
    Name of property for the set of watches in the system.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDebuggerManager
```
public static DebuggerManager getDebuggerManager()
```
    Returns default instance of DebuggerManager.
    
    Returns:
    
    default instance of DebuggerManager
  - getActionsManager
```
public ActionsManager getActionsManager()
```
  - lookup
```
public <T> List<? extends T> lookup(String folder,
                                    Class<T> service)
```
    Returns list of services of given type from given folder.
    
    Specified by:
    
    lookup in interface ContextProvider
    
    Parameters:
    
    service - a type of service to look for
    
    folder - a folder name or null
    
    Returns:
    
    list of services of given type
  - lookupFirst
```
public <T> T lookupFirst(String folder,
                         Class<T> service)
```
    Returns one service of given type from given folder.
    
    Specified by:
    
    lookupFirst in interface ContextProvider
    
    Parameters:
    
    service - a type of service to look for
    
    folder - a folder name or null
    
    Returns:
    
    ne service of given type
  - join
```
public static ContextProvider join(ContextProvider cp1,
                                   ContextProvider cp2)
```
    Join two lookups together. The result will merge the lookups. The result of its DebuggerManager.lookup method will additionally implement Customizer.
    
    Parameters:
    
    cp1 - first lookup
    
    cp2 - second lookup
    
    Returns:
    
    a merger of the two
    
    Since:
    
    org.netbeans.api.debugger/1 1.13
  - startDebugging
```
public DebuggerEngine[] startDebugging(DebuggerInfo info)
```
    Start a new debugging for given DebuggerInfo. DebuggerInfo provides information needed to start new debugging. DebuggerManager finds all SessionProviders and DelegatingSessionProviders installed for given DebuggerInfo, and creates a new Session(s). After that it looks for all DebuggerEngineProviders and DelegatingDebuggerEngineProviders installed for Session, and crates a new DebuggerEngine(s).
    If the implementation of ACTION_START providers support cancellation (implements Cancellable), this startup sequence can be canceled via Thread.interrupt() while startDebugging() method is waiting for the action providers.
    
    Parameters:
    
    info - debugger startup info
    
    Returns:
    
    DebuggerEngines started for given info
  - finishAllSessions
```
public void finishAllSessions()
```
    Kills all Sessions and DebuggerEngines.
  - getCurrentSession
```
public Session getCurrentSession()
```
    Returns current debugger session or null.
    
    Returns:
    
    current debugger session or null
  - setCurrentSession
```
public void setCurrentSession(Session session)
```
    Sets current debugger session.
    
    Parameters:
    
    session - a session to be current
  - getSessions
```
public Session[] getSessions()
```
    Returns set of running debugger sessions.
    
    Returns:
    
    set of running debugger sessions
  - getDebuggerEngines
```
public DebuggerEngine[] getDebuggerEngines()
```
    Returns set of running debugger engines.
    
    Returns:
    
    set of running debugger engines
  - getCurrentEngine
```
public DebuggerEngine getCurrentEngine()
```
    Returns current debugger engine or null.
    
    Returns:
    
    current debugger engine or null
  - addBreakpoint
```
public void addBreakpoint(Breakpoint breakpoint)
```
    Adds a new breakpoint.
    
    Parameters:
    
    breakpoint - a new breakpoint
  - removeBreakpoint
```
public void removeBreakpoint(Breakpoint breakpoint)
```
    Removes breakpoint.
    
    Parameters:
    
    breakpoint - a breakpoint to be removed
  - getBreakpoints
```
public Breakpoint[] getBreakpoints()
```
    Gets all registered breakpoints.
    
    Returns:
    
    all breakpoints
  - createWatch
```
public Watch createWatch(String expr)
```
    Creates a watch with its expression set to an initial value. Also allows creation of a hidden watch (not presented to the user), for example for internal use in the editor to obtain values of variables under the mouse pointer.
    
    Parameters:
    
    expr - expression to watch for (the format is the responsibility of the debugger plug-in implementation, but it is typically a variable name).
    
    Returns:
    
    the new watch
  - createWatch
```
public Watch createWatch(int index,
                         String expr)
```
    Creates a watch with its expression set to an initial value and add it at the specific position
    
    Parameters:
    
    index - the position at which the specified watch is to be inserted
    
    expr - expression to watch for (the format is the responsibility of the debugger plug-in implementation, but it is typically a variable name).
    
    Returns:
    
    the new watch
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the index is out of range (index < 0 || index > getWatches().length)
    
    Since:
    
    1.22
  - createPinnedWatch
```
public Watch createPinnedWatch(String expr,
                               Watch.Pin pin)
```
    Create a watch pinned at the specified pin location.
    
    Parameters:
    
    expr - expression to watch for (the format is the responsibility of the debugger plug-in implementation, but it is typically a variable name).
    
    pin - A pin where the watch should be pinned at.
    
    Returns:
    
    the new watch
    
    Since:
    
    1.54
  - getWatches
```
public Watch[] getWatches()
```
    Gets all shared watches in the system.
    
    Returns:
    
    all watches
  - removeAllWatches
```
public void removeAllWatches()
```
    Removes all watches from the system.
  - reorderWatches
```
public void reorderWatches(int[] permutation)
                    throws IllegalArgumentException
```
    Reorders watches with given permutation.
    
    Parameters:
    
    permutation - The permutation with the length of current watches list
    
    Throws:
    
    IllegalArgumentException - if the permutation is not valid permutation
    
    Since:
    
    1.22
  - addDebuggerListener
```
public void addDebuggerListener(DebuggerManagerListener l)
```
    This listener notificates about changes of breakpoints, watches and threads.
    
    Parameters:
    
    l - listener object.
  - removeDebuggerListener
```
public void removeDebuggerListener(DebuggerManagerListener l)
```
    Removes debugger listener.
    
    Parameters:
    
    l - listener object.
  - addDebuggerListener
```
public void addDebuggerListener(String propertyName,
                                DebuggerManagerListener l)
```
    Add a debuggerManager listener to changes of watches and breakpoints.
    
    Parameters:
    
    propertyName - a name of property to listen on
    
    l - the debuggerManager listener to add
  - removeDebuggerListener
```
public void removeDebuggerListener(String propertyName,
                                   DebuggerManagerListener l)
```
    Remove a debuggerManager listener to changes of watches and breakpoints.
    
    Parameters:
    
    propertyName - a name of property to listen on
    
    l - the debuggerManager listener to remove

Class DebuggerManager

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_BREAKPOINTS_INIT

PROP_BREAKPOINTS

PROP_CURRENT_ENGINE

PROP_CURRENT_SESSION

PROP_SESSIONS

PROP_DEBUGGER_ENGINES

PROP_WATCHES

PROP_WATCHES_INIT

Method Detail

getDebuggerManager

getActionsManager

lookup

lookupFirst

join

startDebugging

finishAllSessions

getCurrentSession

setCurrentSession

getSessions

getDebuggerEngines

getCurrentEngine

addBreakpoint

removeBreakpoint

getBreakpoints

createWatch

createWatch

createPinnedWatch

getWatches

removeAllWatches

reorderWatches

addDebuggerListener

removeDebuggerListener

addDebuggerListener

removeDebuggerListener