oracle.ide.debugger.extender.breakpoint

Interface DebuggerExtenderBreakpoint

All Superinterfaces:

oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

All Known Subinterfaces:

DebuggerExtenderExceptionBreakpoint, DebuggerExtenderFileLineBreakpoint, DebuggerExtenderMethodBreakpoint, DebuggerExtenderPropertiesBreakpoint, DebuggerExtenderURLLineBreakpoint

public interface DebuggerExtenderBreakpoint
extends oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Definition of a Debugger Extender Breakpoint, which provides a read-only view of a breakpoint. This interface will be implemented by both the Debugger and the DebuggerExtender. All DebuggerExtenderBreakpoint instances supplied by the debugger are DebuggerExtenderBreakpoints backed by a debugger implementation. For any DebuggerExtenderBreakpoint that the DebuggerExtender needs to supply to the debugger, it is best to use a DebuggerExtenderBreakpoint previously supplied by the debugger (e.g. from the getBreakpoints or addBreakpoint calls), but any other implementation of DebuggerExtenderBreakpoint can be used, in which case the debugger will call back with @link DebuggerExtender.breakpointsEqual to try to recognize the breakpoint. It is up to the DebuggerExtender to match the DebuggerExtenderBreakpoints implemented by the debugger with their own breakpoint representations

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DebuggerExtenderBreakpoint.BreakpointKind The various breakpoint kinds
static class	DebuggerExtenderBreakpoint.BreakpointScope The various scopes where a breakpoint can be valid
static class	DebuggerExtenderBreakpoint.BreakpointState The various breakpoint states

Method Summary

Modifier and Type	Method and Description
boolean	canEditBreakForThreads() Find out if the user is allowed to edit the break for thread settings
boolean	canEditBreakpointHitActions() Find out if the user is allowed to edit the breakpoint hit actions
boolean	canEditCondition() Find out if the user is allowed to edit the condition
boolean	canEditGroupName() Find out if the user is allowed to edit the groupName
boolean	canEditPassCount() Find out if the user is allowed to edit the passcount
java.lang.String	getBreakForThreadNamed() Find out if the debugger should only acknowledge this breakpoint for one thread.
java.lang.String	getBreakForThreadNotNamed() Find out if the debugger should acknowledge this breakpoint for any thread except one.
java.lang.String	getCondition() Get the condition of this breakpoint.
java.lang.String	getCustomDescription() Get the description of this breakpoint if this is a custom breakpoint with a custom description.
java.lang.String	getCustomTypeString() Get the type string if this is a custom breakpoint with a custom type string.
java.lang.String	getDisableBreakpointGroupOnBreakpointHit() Find out if the debugger should disable a breakpoint group when this breakpoint is hit
java.lang.String	getEnableBreakpointGroupOnBreakpointHit() Find out if the debugger should enable a breakpoint group when this breakpoint is hit
java.lang.String	getGroupName() Get the group name of this breakpoint
java.lang.String	getHiddenCondition() Get the hidden condition of this breakpoint.
DebuggerExtenderBreakpoint.BreakpointKind	getKind() Get the kind of this breakpoint.
DebuggerExtenderBreakpointLogEntry	getLogEntryOnBreakpointHit() Find out if the debugger should make a log entry when the breakpoint is hit.
int	getPassCount() Get the passcount of this breakpoint.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Get the properties of this breakpoint
java.net.URL	getScope() Get the scope of this breakpoint, either null if the breakpoint is global, a workspace URL if the scope is a workspace, or a project URL if the scope is a project.
boolean	isBeepOnBreakpointHit() Find out if the debugger should beep when this breakpoint is hit
boolean	isEnabled() Find out if the preferred state of this breakpoint is enabled
boolean	isHaltOnBreakpointHit() Find out if the debugger should halt when this breakpoint is hit
default DebuggerExtenderAPIVersion	version() Indicates that this breakpoint conforms to the new 13.0.0.1.0 and later Debugger Extender APIs

Method Detail

version

default DebuggerExtenderAPIVersion version()

Indicates that this breakpoint conforms to the new 13.0.0.1.0 and later Debugger Extender APIs

Specified by:

version in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

getScope

java.net.URL getScope()

Get the scope of this breakpoint, either null if the breakpoint is global, a workspace URL if the scope is a workspace, or a project URL if the scope is a project.

Specified by:

getScope in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The scope of the breakpoint

isEnabled

boolean isEnabled()

Find out if the preferred state of this breakpoint is enabled

Specified by:

isEnabled in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the preferred state of this breakpoint is enabled, false otherwise

getCondition

java.lang.String getCondition()

Get the condition of this breakpoint. This is the condition that the user can set and modify when the breakpoint is created or edited. The final condition used by the debugger to determine if this breakpoint is valid is: ( hiddenCondition ) && ( condition )

Specified by:

getCondition in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The condition of this breakpoint which can be null

getHiddenCondition

java.lang.String getHiddenCondition()

Get the hidden condition of this breakpoint. The hidden condition can be set by DebuggerExtenders, and this hidden condition is invisible to the user. The final condition used by the debugger to determine if this breakpoint is valid is: ( hiddenCondition ) && ( condition )

Specified by:

getHiddenCondition in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The hidden condition of this breakpoint which can be null

canEditCondition

boolean canEditCondition()

Find out if the user is allowed to edit the condition

Specified by:

canEditCondition in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the user is allowed to edit the condition

getPassCount

int getPassCount()

Get the passcount of this breakpoint.

Specified by:

getPassCount in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The passcount of this breakpoint, use -1 if there is no passcount

canEditPassCount

boolean canEditPassCount()

Find out if the user is allowed to edit the passcount

Specified by:

canEditPassCount in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the user is allowed to edit the passcount

getGroupName

java.lang.String getGroupName()

Get the group name of this breakpoint

Specified by:

getGroupName in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The group name of this breakpoint, which can be null

canEditGroupName

boolean canEditGroupName()

Find out if the user is allowed to edit the groupName

Specified by:

canEditGroupName in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the user is allowed to edit the groupName

getCustomDescription

java.lang.String getCustomDescription()

Get the description of this breakpoint if this is a custom breakpoint with a custom description. If this is a normal breakpoint, return null and the debugger will use the BreakpointKind to create the description

Specified by:

getCustomDescription in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The description of this breakpoint IFF this is a custom breakpoint, otherwise return null

getCustomTypeString

java.lang.String getCustomTypeString()

Get the type string if this is a custom breakpoint with a custom type string. If this is a normal breakpoint, return null and the debugger will use the BreakpointKind to create the type string

Specified by:

getCustomTypeString in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The type of this breakpoint IFF this is a custom breakpoint, otherwise return null

getBreakForThreadNamed

java.lang.String getBreakForThreadNamed()

Find out if the debugger should only acknowledge this breakpoint for one thread. By default, the debugger will stop for all threads.

Specified by:

getBreakForThreadNamed in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

A thread name

getBreakForThreadNotNamed

java.lang.String getBreakForThreadNotNamed()

Find out if the debugger should acknowledge this breakpoint for any thread except one. By default, the debugger will stop for all threads. This is ignored if getBreakForThreadNamed returns not null

Specified by:

getBreakForThreadNotNamed in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

A thread name

canEditBreakForThreads

boolean canEditBreakForThreads()

Find out if the user is allowed to edit the break for thread settings

Specified by:

canEditBreakForThreads in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the user is allowed to edit the break for thread settings

isHaltOnBreakpointHit

boolean isHaltOnBreakpointHit()

Find out if the debugger should halt when this breakpoint is hit

Specified by:

isHaltOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the debugger should halt, false otherwise

isBeepOnBreakpointHit

boolean isBeepOnBreakpointHit()

Find out if the debugger should beep when this breakpoint is hit

Specified by:

isBeepOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the debugger should beep, false otherwise

getLogEntryOnBreakpointHit

DebuggerExtenderBreakpointLogEntry getLogEntryOnBreakpointHit()

Find out if the debugger should make a log entry when the breakpoint is hit. Just by returning a valid DebuggerBreakpointLogEntry object and enabling it, the debugger will make simple log entries. The DebuggerExtender can decorate the log entries by using the various methods in DebuggerExtenderBreakpointLogEntry

Specified by:

getLogEntryOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

A DebuggerExtenderBreakpointLogEntry if the debugger should log an entry, or null

getEnableBreakpointGroupOnBreakpointHit

java.lang.String getEnableBreakpointGroupOnBreakpointHit()

Find out if the debugger should enable a breakpoint group when this breakpoint is hit

Specified by:

getEnableBreakpointGroupOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The name of a breakpoint group if the debugger should enable a breakpoint group when the breakpoint is hit, null otherwise

getDisableBreakpointGroupOnBreakpointHit

java.lang.String getDisableBreakpointGroupOnBreakpointHit()

Find out if the debugger should disable a breakpoint group when this breakpoint is hit

Specified by:

getDisableBreakpointGroupOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The name of a breakpoint group if the debugger should disable a breakpoint group when the breakpoint is hit, null otherwise

canEditBreakpointHitActions

boolean canEditBreakpointHitActions()

Find out if the user is allowed to edit the breakpoint hit actions

Specified by:

canEditBreakpointHitActions in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

True if the user is allowed to edit the breakpoint hit actions

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Get the properties of this breakpoint

Specified by:

getProperties in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The properties of this breakpoint which can be an empty map

getKind

DebuggerExtenderBreakpoint.BreakpointKind getKind()

Get the kind of this breakpoint. It is IMPORTANT to return the correct BreakpointKind depending on the kind of this breakpoint. The debugger will do casting in the following way: METHOD: cast to DebuggerExtenderMethodBreakpoint FILE_LINE: cast to DebuggerExtenderFileLineBreakpoint URL_LINE: cast to DebuggerExtenderURLLineBreakpoint EXCEPTION: cast to DebuggerExtenderExceptionBreakpoint PROPERTIES: cast to DebuggerExtenderPropertiesBreakpoint and IllegalArgumentExceptions are thrown if the casts don't work The possible BreakpointKinds are fixed, but the DebuggerExtender is free to customize breakpoints by giving them their own custom type string and custom description

Specified by:

getKind in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerExtenderBreakpointLogEntry,DebuggerExtenderBreakpoint.BreakpointKind>

Returns:

The kind of this breakpoint