oracle.ide.debugger.extender

Interface DebuggerExtenderCallback

All Superinterfaces:

oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

public interface DebuggerExtenderCallback
extends oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Interface returned by the debugger when a DebuggerExtender is added. Allows the DebuggerExtender to give commands to the debugger.

Method Summary

Modifier and Type	Method and Description
DebuggerExtenderBreakpoint	addBreakpoint(DebuggerExtenderBreakpoint breakpoint) Called by the DebuggerExtender to add a new breakpoint.
boolean	deleteBreakpoint(DebuggerExtenderBreakpoint breakpoint) Called by the DebuggerExtender to delete a previously added breakpoint.
boolean	editBreakpoint(DebuggerExtenderBreakpoint breakpoint) Called by the DebuggerExtender to ask the Debugger to show the dialog where the user can edit the incoming breakpoint.
javax.swing.Icon	getBreakpointIcon(DebuggerExtenderBreakpoint breakpoint) Called by the DebuggerExtender to get the icon that corresponds to the current state of a previously added breakpoint in the context of the current debugging process
java.util.List<? extends DebuggerExtenderBreakpoint>	getBreakpoints() Called by the DebuggerExtender to get the list of breakpoints previously added by this DebuggerExtender (and not deleted yet).
DebuggerExtenderBreakpoint.BreakpointState	getBreakpointState(DebuggerExtenderBreakpoint breakpoint) Called by the DebuggerExtender to get the current state of a previously added breakpoint in the context of the current debugging process
default DebuggerExtenderAPIVersion	getDebuggerExtenderAPIVersion() Called by core debugger implementation to see what version of the DebuggerExtender API is used by an extender, so that appropriate return types can be used for methods that differ between versions.
DebuggerExtenderBreakpoint.BreakpointScope	getDefaultBreakpointScope() Called by the DebuggerExtender to ask the Debugger what the default breakpoint scope is for new breakpoints.
DebuggerExtenderBreakpoint	getDefaultBreakpointSettings() Called by the DebuggerExtender to ask the Debugger for the settings of a 'default' breakpoint.
void	registerCustomBreakpointType(java.lang.String customBreakpointType, DebuggerExtenderBreakpoint.BreakpointKind breakpointKind) Deprecated. Use registerCustomBreakpointType(String, BreakpointKind, DebuggerBreakpoint) instead.
void	registerCustomBreakpointType(java.lang.String customBreakpointType, DebuggerExtenderBreakpoint.BreakpointKind breakpointKind, DebuggerExtenderBreakpoint breakpointTemplate) Deprecated. The programmatic way of registering breakpoint types is discouraged. Instead register in a declarative way in extension.xml, as follows: Use a fully qualified class name of an implementation of oracle.ide.runner.DebuggerBreakpointDeclarator for the 'class' attribute Use the unique type string of the breakpoint type for the 'type-string' attribute, such as 'ADF Breakpoint' Add a <hooks> section or use the existing one Add a <jdeveloper-hook> section or use the existing one <hooks> <jdeveloper-hook xmlns="http://xmlns.oracle.com/jdeveloper/1013/extension"> <debugger-hook> <debugger-extender-custom-breakpoint-type class="mycompany.MyDebuggerBreakpointDeclarator" type-string="My Breakpoint" /> </debugger-hook> </jdeveloper-hook> </hooks>
boolean	setEnableBreakpoint(DebuggerExtenderBreakpoint breakpoint, boolean enable) Called by the DebuggerExtender to set the preferred state of a previously added breakpoint to enabled or disabled

Method Detail

getDebuggerExtenderAPIVersion

default DebuggerExtenderAPIVersion getDebuggerExtenderAPIVersion()

Called by core debugger implementation to see what version of the DebuggerExtender API is used by an extender, so that appropriate return types can be used for methods that differ between versions.

addBreakpoint

DebuggerExtenderBreakpoint addBreakpoint(DebuggerExtenderBreakpoint breakpoint)

Called by the DebuggerExtender to add a new breakpoint.

Specified by:

addBreakpoint in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

breakpoint - The new breakpoint as defined by the DebuggerExtender

Returns:

The breakpoint as backed by the debugger which will not be the same object as the parameter 'breakpoint' (even though the same interface is used).

deleteBreakpoint

boolean deleteBreakpoint(DebuggerExtenderBreakpoint breakpoint)

Called by the DebuggerExtender to delete a previously added breakpoint.

Specified by:

deleteBreakpoint in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

breakpoint - The breakpoint to delete

Returns:

True if the breakpoint was deleted, false otherwise

setEnableBreakpoint

boolean setEnableBreakpoint(DebuggerExtenderBreakpoint breakpoint,
                            boolean enable)

Called by the DebuggerExtender to set the preferred state of a previously added breakpoint to enabled or disabled

Specified by:

setEnableBreakpoint in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

breakpoint - The breakpoint

enable - True if the preferred state should be set to enabled, false if the preferred state should be set to disabled

Returns:

True if the breakpoint was enabled/disabled, false otherwise

getBreakpoints

java.util.List<? extends DebuggerExtenderBreakpoint> getBreakpoints()

Called by the DebuggerExtender to get the list of breakpoints previously added by this DebuggerExtender (and not deleted yet). This method should only be called after the DebuggerExtender method breakpointsLoaded() has been received, and can be called anytime thereafter. A caller can also call this method just once and keep track from then on by monitoring the addBreakpoint and deleteBreakpoint and breakpointDeleted methods.

Specified by:

getBreakpoints in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Returns:

A list of breakpoints which will be null if the debugger has not loaded any breakpoints yet, and empty if there are no breakpoints associated with this DebuggerExtender

getBreakpointState

DebuggerExtenderBreakpoint.BreakpointState getBreakpointState(DebuggerExtenderBreakpoint breakpoint)

Called by the DebuggerExtender to get the current state of a previously added breakpoint in the context of the current debugging process

Specified by:

getBreakpointState in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

breakpoint - The breakpoint

Returns:

One of ENABLED, DISABLED, UNVERIFIED, VERIFIED or null if the breakpoint was not recognized

getBreakpointIcon

javax.swing.Icon getBreakpointIcon(DebuggerExtenderBreakpoint breakpoint)

Called by the DebuggerExtender to get the icon that corresponds to the current state of a previously added breakpoint in the context of the current debugging process

Specified by:

getBreakpointIcon in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

breakpoint - The breakpoint

Returns:

An Icon which will be null if the breakpoint was not recognized

registerCustomBreakpointType

@Deprecated
void registerCustomBreakpointType(java.lang.String customBreakpointType,
                                              DebuggerExtenderBreakpoint.BreakpointKind breakpointKind)

Deprecated. Use registerCustomBreakpointType(String, BreakpointKind, DebuggerBreakpoint) instead.

Called by the DebuggerExtender to register a new custom breakpoint type. Breakpoints of this type will return this same type String in their getCustomTypeString() method. The debugger will use this type String to create and edit breakpoints of this type. A good time to call this method is after the breakpointsLoaded call has been received

Specified by:

registerCustomBreakpointType in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

customBreakpointType - The new custom breakpoint type String. This type is further used by the DebuggerExtender to create and edit breakpoints of this type

breakpointKind - The underlying breakpoint kind of this breakpoint type

registerCustomBreakpointType

@Deprecated
void registerCustomBreakpointType(java.lang.String customBreakpointType,
                                              DebuggerExtenderBreakpoint.BreakpointKind breakpointKind,
                                              DebuggerExtenderBreakpoint breakpointTemplate)

Deprecated. The programmatic way of registering breakpoint types is discouraged. Instead register in a declarative way in extension.xml, as follows: Use a fully qualified class name of an implementation of oracle.ide.runner.DebuggerBreakpointDeclarator for the 'class' attribute
Use the unique type string of the breakpoint type for the 'type-string' attribute, such as 'ADF Breakpoint'
Add a <hooks> section or use the existing one
Add a <jdeveloper-hook> section or use the existing one

<hooks>
<jdeveloper-hook xmlns="http://xmlns.oracle.com/jdeveloper/1013/extension">
<debugger-hook>
<debugger-extender-custom-breakpoint-type
class="mycompany.MyDebuggerBreakpointDeclarator" type-string="My Breakpoint" />
</debugger-hook>
</jdeveloper-hook>
</hooks>

Called by the DebuggerExtender to register a new custom breakpoint type. Breakpoints of this type will return this same type String in their getCustomTypeString() method. The debugger will use this type String, together with the optional template to create and edit breakpoints of this type. A good time to call this method is after the breakpointsLoaded call has been received

Specified by:

registerCustomBreakpointType in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

customBreakpointType - The new custom breakpoint type String. This type is further used by the DebuggerExtender to create and edit breakpoints of this type

breakpointKind - The underlying breakpoint kind of this breakpoint type

breakpointTemplate - The (optional) template that will be used when new breakpoints are created. This is useful if certain properties of a new breakpoint, such as the condition, have defaults and/or are read-only and should not be editable by the user on creation.

getDefaultBreakpointScope

DebuggerExtenderBreakpoint.BreakpointScope getDefaultBreakpointScope()

Called by the DebuggerExtender to ask the Debugger what the default breakpoint scope is for new breakpoints. Since the user can change this setting at any time, a good time to call this is when the DebuggerExtender creates a new breakpoint.

Specified by:

getDefaultBreakpointScope in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Returns:

The default breakpoint scope for new breakpoints.

editBreakpoint

boolean editBreakpoint(DebuggerExtenderBreakpoint breakpoint)

Called by the DebuggerExtender to ask the Debugger to show the dialog where the user can edit the incoming breakpoint. If the user successfully edited the breakpoint, this method will return true, and the DebuggerExtender will also get called back through DebuggerExtender.breakpointChanged with BreakpointState.EDITED

Specified by:

editBreakpoint in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Parameters:

breakpoint - The breakpoint

Returns:

True if the user exited the dialog with the OK button, false if the breakpoint was not recognized or if the user cancelled the dialog.

getDefaultBreakpointSettings

DebuggerExtenderBreakpoint getDefaultBreakpointSettings()

Called by the DebuggerExtender to ask the Debugger for the settings of a 'default' breakpoint. The DebuggerExtender can use this default breakpoint to create a template for custom breakpoints.

Specified by:

getDefaultBreakpointSettings in interface oracle.ideimpl.debugger.extender.CommonExtenderCallbackBase<DebuggerExtenderBreakpoint,DebuggerExtenderBreakpoint.BreakpointKind,DebuggerExtenderBreakpoint.BreakpointScope,DebuggerExtenderBreakpoint.BreakpointState>

Returns:

A 'default' breakpoint