oracle.ide.runner
Class Debugger

java.lang.Object
  oracle.ide.runner.Debugger

public abstract class Debugger
extends java.lang.Object

The Debugger class provides methods that interact with the debugger.

Constructor Summary

Debugger()

Method Summary

DebuggerExtenderCallback	addDebuggerExtender(DebuggerExtender extender) Add a DebuggerExtender, which can augment and modify Debugger behavior
abstract void	addDebuggerListener(DebuggerAdapter debuggerListener)
DebuggerWindowProviderCallback	addDebuggerWindowProvider(DebuggerWindowProvider provider) Add a DebuggerWindowProvider, which will provide a custom debugger window
void	addInspectorExpressionProvider(DebuggerInspectorExpressionProvider expressionProvider) Add a DebuggerInspectorExpressionProvider which will be used to make a suitable inspector expression when the user requests an inspect and there is no selection in the editor
abstract void	addObjectPreferencesExpansion(java.lang.String className, java.lang.String expansion, boolean select) Add a string of items to evaluate when expanding objects of a specified class in the debugger.
abstract void	addObjectPreferencesExpression(java.lang.String className, java.lang.String expression, boolean select) Add an expression to evaluate when displaying objects of a specified class in the debugger.
void	addObjectPreferencesHideAllFields(java.lang.String className) Add an Object Preferences item indicating that all fields of a class should be hidden when that class is expanded in the debugger.
void	addObjectPreferencesHideField(java.lang.String className, java.lang.String fieldName) Add an Object Preferences item indicating that a field of a class should be hidden when that class is expanded in the debugger
void	addObjectPreferencesIcon(java.lang.String className, java.lang.String iconName) Add an Object Preferences item indicating the icon that should be used when a class of a certain name is displayed in the debugger data panes
abstract void	addRunAndDebugToContextMenu(ContextMenu popup, Context context)
abstract void	addSmartDataProvider(SmartDataProvider smartDataProvider)
abstract void	addToolTipExpressionProvider(ToolTipExpressionProvider toolTipExpressionProvider)
abstract java.lang.Object	evaluateNumericExpression(java.lang.String expression) Have the debugger evaluate a numeric expression.
abstract ContextMenu	getContextMenu() Returns the ContextMenu that the debugger uses in debugger windows.
static Debugger	getDebugger() Returns the active Debugger instance.
abstract javax.swing.JMenu	getDebugMenu() Returns the Debug menu that the debugger has added to the main menu bar.
javax.swing.JMenu	getViewMenu() Returns the View Debugger sub menu if it exists
abstract boolean	isDebugging() Returns true if the debugger is currently debugging one or more processes.
abstract boolean	isStackTraceLine(java.lang.String line)
abstract java.net.URL	parseStackTraceLine(Workspace workspace, Project project, java.lang.String stackTraceLine)
abstract void	redefineClasses(java.util.Map nameToGuts) Deprecated.
abstract void	redefineClasses(Project project, java.util.Map nameToGuts) Tells the debugger to redefine some classes that have been recompiled.
void	removeDebuggerExtender(DebuggerExtender extender) Remove a previously added DebuggerExtender.
abstract void	removeDebuggerListener(DebuggerAdapter debuggerListener)
void	removeDebuggerWindowProvider(DebuggerWindowProvider provider) Remove a previously added DebuggerWindowProvider.
void	removeInspectorExpressionProvider(DebuggerInspectorExpressionProvider expressionProvider) Remove a previously added DebuggerInspectorExpressionProvider
abstract void	removeSmartDataProvider(SmartDataProvider smartDataProvider)
abstract void	removeToolTipExpressionProvider(ToolTipExpressionProvider toolTipExpressionProvider)
static void	setDebugger(Debugger debugger) Sets the active Debugger instance.
abstract boolean	showSourceFileForStackTraceLine(Workspace workspace, Project project, java.lang.String stackTraceLine)
abstract boolean	showSourceFileForStackTraceLine(Workspace workspace, Project project, java.net.URL urlWithLine)
abstract void	startDebugger(Context context, DebuggerStartCallback callBack) Start the debugger with the given context with the options of providing a call back at different stages of the starting process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Debugger

public Debugger()

Method Detail

getDebugger

public static Debugger getDebugger()

Returns the active Debugger instance.

setDebugger

public static void setDebugger(Debugger debugger)

Sets the active Debugger instance.

getDebugMenu

public abstract javax.swing.JMenu getDebugMenu()

Returns the Debug menu that the debugger has added to the main menu bar.

Returns:

the Debug menu

getContextMenu

public abstract ContextMenu getContextMenu()

Returns the ContextMenu that the debugger uses in debugger windows.

Returns:

the debugger context menu

getViewMenu

public javax.swing.JMenu getViewMenu()

Returns the View Debugger sub menu if it exists

Returns:

The View Debugger sub menu or null if it doesn't exist.

isDebugging

public abstract boolean isDebugging()

Returns true if the debugger is currently debugging one or more processes.

startDebugger

public abstract void startDebugger(Context context,
                                   DebuggerStartCallback callBack)

Start the debugger with the given context with the options of providing a call back at different stages of the starting process

Parameters:

context - The context to start the debugger in

callBack - A call back to inform the caller of the progress

redefineClasses

@Deprecated
public abstract void redefineClasses(java.util.Map nameToGuts)

Deprecated.

Tells the debugger to redefine some classes. Note that the debugger may choose to perform the class redefinition asynchronously. It is not guaranteed that the class redefinition will be finished when this method returns.

Parameters:

nameToGuts - a map where the keys are full class names (String) and the values are the guts of the class file (byte[]).

redefineClasses

public abstract void redefineClasses(Project project,
                                     java.util.Map nameToGuts)

Tells the debugger to redefine some classes that have been recompiled. Note that the debugger may choose to perform the class redefinition asynchronously. It is not guaranteed that the class redefinition will be finished when this method returns.

Parameters:

project - the project that was recompiled

nameToGuts - a map where the keys are full class names (String) and the values are the guts of the class file (byte[]).

isStackTraceLine

public abstract boolean isStackTraceLine(java.lang.String line)

showSourceFileForStackTraceLine

public abstract boolean showSourceFileForStackTraceLine(Workspace workspace,
                                                        Project project,
                                                        java.lang.String stackTraceLine)

parseStackTraceLine

public abstract java.net.URL parseStackTraceLine(Workspace workspace,
                                                 Project project,
                                                 java.lang.String stackTraceLine)

showSourceFileForStackTraceLine

public abstract boolean showSourceFileForStackTraceLine(Workspace workspace,
                                                        Project project,
                                                        java.net.URL urlWithLine)

addSmartDataProvider

public abstract void addSmartDataProvider(SmartDataProvider smartDataProvider)

removeSmartDataProvider

public abstract void removeSmartDataProvider(SmartDataProvider smartDataProvider)

addToolTipExpressionProvider

public abstract void addToolTipExpressionProvider(ToolTipExpressionProvider toolTipExpressionProvider)

removeToolTipExpressionProvider

public abstract void removeToolTipExpressionProvider(ToolTipExpressionProvider toolTipExpressionProvider)

addRunAndDebugToContextMenu

public abstract void addRunAndDebugToContextMenu(ContextMenu popup,
                                                 Context context)

addDebuggerListener

public abstract void addDebuggerListener(DebuggerAdapter debuggerListener)

removeDebuggerListener

public abstract void removeDebuggerListener(DebuggerAdapter debuggerListener)

evaluateNumericExpression

public abstract java.lang.Object evaluateNumericExpression(java.lang.String expression)

Have the debugger evaluate a numeric expression. returns a wrapper object (Boolean, Byte, Character, Double, Float, Int, Short, or Long) returns null if the expression is invalid or can not be evaluated.

addDebuggerWindowProvider

public DebuggerWindowProviderCallback addDebuggerWindowProvider(DebuggerWindowProvider provider)

Add a DebuggerWindowProvider, which will provide a custom debugger window

Parameters:

provider - A DebuggerWindowProvider which should not be null

Returns:

a valid DebuggerWindowProviderCallback if the provider was successfully added, null otherwise

removeDebuggerWindowProvider

public void removeDebuggerWindowProvider(DebuggerWindowProvider provider)

Remove a previously added DebuggerWindowProvider.

Parameters:

provider - A DebuggerWindowProvider which should not be null

addDebuggerExtender

public DebuggerExtenderCallback addDebuggerExtender(DebuggerExtender extender)

Add a DebuggerExtender, which can augment and modify Debugger behavior

Parameters:

extender - A DebuggerExtender which should not be null

Returns:

A valid DebuggerExtenderCallback if the extender was successfully added, null otherwise

removeDebuggerExtender

public void removeDebuggerExtender(DebuggerExtender extender)

Remove a previously added DebuggerExtender.

Parameters:

extender - A DebuggerExtender which should not be null

addObjectPreferencesExpression

public abstract void addObjectPreferencesExpression(java.lang.String className,
                                                    java.lang.String expression,
                                                    boolean select)

Add an expression to evaluate when displaying objects of a specified class in the debugger.

Parameters:

className - the fully qualified name of a class to add an expression for.

expression - the expression to evaluate.

select - whether the expression is selected by default. If false, the expression is available as one of the selectable expressions for the className in the object preferences dialog.

addObjectPreferencesExpansion

public abstract void addObjectPreferencesExpansion(java.lang.String className,
                                                   java.lang.String expansion,
                                                   boolean select)

Add a string of items to evaluate when expanding objects of a specified class in the debugger. Item separator is ';'.

Parameters:

className - the fully qualified name of a class to add an expression for.

expansion - the string of items to evaluate.

select - whether the expansion is selected by default. If false, the expansion is available as one of the selectable expansions for the className in the object preferences dialog.

addObjectPreferencesHideAllFields

public void addObjectPreferencesHideAllFields(java.lang.String className)

Add an Object Preferences item indicating that all fields of a class should be hidden when that class is expanded in the debugger.

Parameters:

className - the fully qualified name of a class

addObjectPreferencesHideField

public void addObjectPreferencesHideField(java.lang.String className,
                                          java.lang.String fieldName)

Add an Object Preferences item indicating that a field of a class should be hidden when that class is expanded in the debugger

Parameters:

className - the fully qualified name of a class

fieldName - the name of a field of that class

addObjectPreferencesIcon

public void addObjectPreferencesIcon(java.lang.String className,
                                     java.lang.String iconName)

Add an Object Preferences item indicating the icon that should be used when a class of a certain name is displayed in the debugger data panes

Parameters:

className - the fully qualified name of a class

iconName - the name of an icon such as "${OracleIcons.QUICK_NAV}" or "/oracle/jdevimpl/runner/debug/images/verifiedbreakpoint.png"

addInspectorExpressionProvider

public void addInspectorExpressionProvider(DebuggerInspectorExpressionProvider expressionProvider)

Add a DebuggerInspectorExpressionProvider which will be used to make a suitable inspector expression when the user requests an inspect and there is no selection in the editor

Parameters:

expressionProvider - A DebuggerInspectorExpressionProvider which should not be null

removeInspectorExpressionProvider

public void removeInspectorExpressionProvider(DebuggerInspectorExpressionProvider expressionProvider)

Remove a previously added DebuggerInspectorExpressionProvider

Parameters:

expressionProvider - A DebuggerInspectorExpressionProvider which should not be null