DebuggerBreakpoint (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

All Superinterfaces:

oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>

All Known Subinterfaces:

DebuggerExceptionBreakpoint, DebuggerFileLineBreakpoint, DebuggerMethodBreakpoint, DebuggerPropertiesBreakpoint, DebuggerURLLineBreakpoint

Deprecated.
Moved and renamed to @link oracle.ide.debugger.extender.breakpoint.DebuggerExtenderBreakpoint
```
@Deprecated
public interface DebuggerBreakpoint
extends oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
```
Definition of a Debugger Breakpoint, which provides a read-only view of a breakpoint. This interface will be implemented by both the Debugger and the DebuggerExtender! All DebuggerBreakpoint instances supplied by the debugger are DebuggerBreakpoints backed by a debugger implementation. For any DebuggerBreakpoint that the DebuggerExtender needs to supply to the debugger, it is best to use a DebuggerBreakpoint previously supplied by the debugger (e.g. from the getBreakpoints or addBreakpoint calls), but any other implementation of DebuggerBreakpoint can be used, in which case the debugger will call back with DebuggerExtender.breakpointsEqual to try to recognize the breakpoint. It is up to the DebuggerExtender to match the DebuggerBreakpoints implemented by the debugger with their own breakpoint representations

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DebuggerBreakpoint.BreakpointKind` Deprecated. The various breakpoint kinds
`static class`	`DebuggerBreakpoint.BreakpointScope` Deprecated. The various scopes where a breakpoint can be valid
`static class`	`DebuggerBreakpoint.BreakpointState` Deprecated. The various breakpoint states

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canEditBreakForThreads()` Deprecated. Find out if the user is allowed to edit the break for thread settings
`boolean`	`canEditBreakpointHitActions()` Deprecated. Find out if the user is allowed to edit the breakpoint hit actions
`boolean`	`canEditCondition()` Deprecated. Find out if the user is allowed to edit the condition
`boolean`	`canEditGroupName()` Deprecated. Find out if the user is allowed to edit the groupName
`boolean`	`canEditPassCount()` Deprecated. Find out if the user is allowed to edit the passcount
`java.lang.String`	`getBreakForThreadNamed()` Deprecated. Find out if the debugger should only acknowledge this breakpoint for one thread.
`java.lang.String`	`getBreakForThreadNotNamed()` Deprecated. Find out if the debugger should acknowledge this breakpoint for any thread except one.
`java.lang.String`	`getCondition()` Deprecated. Get the condition of this breakpoint.
`java.lang.String`	`getCustomDescription()` Deprecated. Get the description of this breakpoint if this is a custom breakpoint with a custom description.
`java.lang.String`	`getCustomTypeString()` Deprecated. Get the type string if this is a custom breakpoint with a custom type string.
`java.lang.String`	`getDisableBreakpointGroupOnBreakpointHit()` Deprecated. Find out if the debugger should disable a breakpoint group when this breakpoint is hit
`java.lang.String`	`getEnableBreakpointGroupOnBreakpointHit()` Deprecated. Find out if the debugger should enable a breakpoint group when this breakpoint is hit
`java.lang.String`	`getGroupName()` Deprecated. Get the group name of this breakpoint
`java.lang.String`	`getHiddenCondition()` Deprecated. Get the hidden condition of this breakpoint.
`DebuggerBreakpoint.BreakpointKind`	`getKind()` Deprecated. Get the kind of this breakpoint.
`DebuggerBreakpointLogEntry`	`getLogEntryOnBreakpointHit()` Deprecated. Find out if the debugger should make a log entry when the breakpoint is hit.
`int`	`getPassCount()` Deprecated. Get the passcount of this breakpoint.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Deprecated. Get the properties of this breakpoint
`java.net.URL`	`getScope()` Deprecated. 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()` Deprecated. Find out if the debugger should beep when this breakpoint is hit
`boolean`	`isEnabled()` Deprecated. Find out if the preferred state of this breakpoint is enabled
`boolean`	`isHaltOnBreakpointHit()` Deprecated. Find out if the debugger should halt when this breakpoint is hit
`default DebuggerExtenderAPIVersion`	`version()` Deprecated.

- Method Detail
  - version
```
default DebuggerExtenderAPIVersion version()
```
    Deprecated.
    
    Specified by:
    
    version in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
  - getScope
```
java.net.URL getScope()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The scope of the breakpoint
  - isEnabled
```
boolean isEnabled()
```
    Deprecated.
    
    Find out if the preferred state of this breakpoint is enabled
    
    Specified by:
    
    isEnabled in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    True if the preferred state of this breakpoint is enabled, false otherwise
  - getCondition
```
java.lang.String getCondition()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The condition of this breakpoint which can be null
  - getHiddenCondition
```
java.lang.String getHiddenCondition()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The hidden condition of this breakpoint which can be null
  - canEditCondition
```
boolean canEditCondition()
```
    Deprecated.
    
    Find out if the user is allowed to edit the condition
    
    Specified by:
    
    canEditCondition in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    True if the user is allowed to edit the condition
  - getPassCount
```
int getPassCount()
```
    Deprecated.
    
    Get the passcount of this breakpoint.
    
    Specified by:
    
    getPassCount in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The passcount of this breakpoint, use -1 if there is no passcount
  - canEditPassCount
```
boolean canEditPassCount()
```
    Deprecated.
    
    Find out if the user is allowed to edit the passcount
    
    Specified by:
    
    canEditPassCount in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    True if the user is allowed to edit the passcount
  - getGroupName
```
java.lang.String getGroupName()
```
    Deprecated.
    
    Get the group name of this breakpoint
    
    Specified by:
    
    getGroupName in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The group name of this breakpoint, which can be null
  - canEditGroupName
```
boolean canEditGroupName()
```
    Deprecated.
    
    Find out if the user is allowed to edit the groupName
    
    Specified by:
    
    canEditGroupName in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    True if the user is allowed to edit the groupName
  - getCustomDescription
```
java.lang.String getCustomDescription()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The description of this breakpoint IFF this is a custom breakpoint, otherwise return null
  - getCustomTypeString
```
java.lang.String getCustomTypeString()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The type of this breakpoint IFF this is a custom breakpoint, otherwise return null
  - getBreakForThreadNamed
```
java.lang.String getBreakForThreadNamed()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    A thread name
  - getBreakForThreadNotNamed
```
java.lang.String getBreakForThreadNotNamed()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    A thread name
  - canEditBreakForThreads
```
boolean canEditBreakForThreads()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    True if the user is allowed to edit the break for thread settings
  - isHaltOnBreakpointHit
```
boolean isHaltOnBreakpointHit()
```
    Deprecated.
    
    Find out if the debugger should halt when this breakpoint is hit
    
    Specified by:
    
    isHaltOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    True if the debugger should halt, false otherwise
  - isBeepOnBreakpointHit
```
boolean isBeepOnBreakpointHit()
```
    Deprecated.
    
    Find out if the debugger should beep when this breakpoint is hit
    
    Specified by:
    
    isBeepOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    True if the debugger should beep, false otherwise
  - getLogEntryOnBreakpointHit
```
DebuggerBreakpointLogEntry getLogEntryOnBreakpointHit()
```
    Deprecated.
    
    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 DebuggerBreakpointLogEntry
    
    Specified by:
    
    getLogEntryOnBreakpointHit in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    A DebuggerBreakpointLogEntry if the debugger should log an entry, or null
  - getEnableBreakpointGroupOnBreakpointHit
```
java.lang.String getEnableBreakpointGroupOnBreakpointHit()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.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()
```
    Deprecated.
    
    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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.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()
```
    Deprecated.
    
    Find out if the user is allowed to edit the breakpoint hit actions
    
    Specified by:
    
    canEditBreakpointHitActions in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.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()
```
    Deprecated.
    
    Get the properties of this breakpoint
    
    Specified by:
    
    getProperties in interface oracle.ideimpl.debugger.extender.breakpoint.CommonBreakpointBase<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The properties of this breakpoint which can be an empty map
  - getKind
```
DebuggerBreakpoint.BreakpointKind getKind()
```
    Deprecated.
    
    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 DebuggerMethodBreakpoint FILE_LINE: cast to DebuggerFileLineBreakpoint URL_LINE: cast to DebuggerURLLineBreakpoint EXCEPTION: cast to DebuggerExceptionBreakpoint PROPERTIES: cast to DebuggerPropertiesBreakpoint 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<DebuggerBreakpointLogEntry,DebuggerBreakpoint.BreakpointKind>
    
    Returns:
    
    The kind of this breakpoint

Interface DebuggerBreakpoint

Nested Class Summary

Method Summary

Method Detail

version

getScope

isEnabled

getCondition

getHiddenCondition

canEditCondition

getPassCount

canEditPassCount

getGroupName

canEditGroupName

getCustomDescription

getCustomTypeString

getBreakForThreadNamed

getBreakForThreadNotNamed

canEditBreakForThreads

isHaltOnBreakpointHit

isBeepOnBreakpointHit

getLogEntryOnBreakpointHit

getEnableBreakpointGroupOnBreakpointHit

getDisableBreakpointGroupOnBreakpointHit

canEditBreakpointHitActions

getProperties

getKind