Breakpoint (Debugger Core API)

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

public abstract class Breakpoint
extends Object

Abstract definition of breakpoint.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Breakpoint.GroupProperties` Group properties of breakpoint.
`static class`	`Breakpoint.HIT_COUNT_FILTERING_STYLE` The style of filtering of hit counts.
`static class`	`Breakpoint.VALIDITY` Validity values

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_DISPOSED` Property name for disposed state of the breakpoint.
`static String`	`PROP_ENABLED` Property name for enabled status of the breakpoint.
`static String`	`PROP_GROUP_NAME` Property name for name of group of the breakpoint.
`static String`	`PROP_GROUP_PROPERTIES` Property name for other group properties of the breakpoint.
`static String`	`PROP_HIT_COUNT_FILTER` Property name constant.
`static String`	`PROP_VALIDITY` Property name for breakpoint validity

Constructor Summary

Constructors
Constructor and Description

Breakpoint()

Constructors
Constructor and Description
`Breakpoint()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a listener to property changes.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener l)` Adds a property change listener.
`boolean`	`canHaveDependentBreakpoints()` Determines if the breakpoint supports dependent breakpoints.
`abstract void`	`disable()` Disables the breakpoint.
`protected void`	`dispose()` Called when breakpoint is removed.
`abstract void`	`enable()` Enables the breakpoint.
`protected void`	`firePropertyChange(String name, Object o, Object n)` Fire property change.
`Set<Breakpoint>`	`getBreakpointsToDisable()` Get the set of breakpoints that will be disabled after this breakpoint is hit.
`Set<Breakpoint>`	`getBreakpointsToEnable()` Get the set of breakpoints that will be enabled after this breakpoint is hit.
`String`	`getGroupName()` Get the name of a user-created group for this breakpoint.
`Breakpoint.GroupProperties`	`getGroupProperties()` Get group properties of the breakpoint.
`int`	`getHitCountFilter()` Get the hit count filter.
`Breakpoint.HIT_COUNT_FILTERING_STYLE`	`getHitCountFilteringStyle()` Get the style of hit count filtering.
`Breakpoint.VALIDITY`	`getValidity()` Get the validity of this breakpoint.
`String`	`getValidityMessage()` Get the message describing the current validity.
`abstract boolean`	`isEnabled()` Test whether the breakpoint is enabled.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Remove a listener to property changes.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener l)` Removes a property change listener.
`void`	`setBreakpointsToDisable(Set<Breakpoint> breakpointsToDisable)` Set the set of breakpoints that will be disabled after this breakpoint is hit.
`void`	`setBreakpointsToEnable(Set<Breakpoint> breakpointsToEnable)` Set the set of breakpoints that will be enabled after this breakpoint is hit.
`void`	`setGroupName(String newGroupName)` Set the name of a user-created group for this breakpoint.
`void`	`setHitCountFilter(int hitCountFilter, Breakpoint.HIT_COUNT_FILTERING_STYLE hitCountFilteringStyle)` Set the hit count filter and the style of filtering.
`protected void`	`setValidity(Breakpoint.VALIDITY validity, String reason)` Set the validity of this breakpoint.

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

- Field Detail
  - PROP_ENABLED
```
public static final String PROP_ENABLED
```
    Property name for enabled status of the breakpoint.
    
    See Also:
    
    Constant Field Values
  - PROP_DISPOSED
```
public static final String PROP_DISPOSED
```
    Property name for disposed state of the breakpoint.
    
    See Also:
    
    Constant Field Values
  - PROP_GROUP_NAME
```
public static final String PROP_GROUP_NAME
```
    Property name for name of group of the breakpoint.
    
    See Also:
    
    Constant Field Values
  - PROP_GROUP_PROPERTIES
```
public static final String PROP_GROUP_PROPERTIES
```
    Property name for other group properties of the breakpoint.
    
    Since:
    
    1.25
    
    See Also:
    
    Constant Field Values
  - PROP_VALIDITY
```
public static final String PROP_VALIDITY
```
    Property name for breakpoint validity
    
    See Also:
    
    Constant Field Values
  - PROP_HIT_COUNT_FILTER
```
public static final String PROP_HIT_COUNT_FILTER
```
    Property name constant.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Breakpoint
```
public Breakpoint()
```
- Method Detail
  - dispose
```
protected void dispose()
```
    Called when breakpoint is removed.
  - isEnabled
```
public abstract boolean isEnabled()
```
    Test whether the breakpoint is enabled.
    
    Returns:
    
    true if so
  - disable
```
public abstract void disable()
```
    Disables the breakpoint.
  - enable
```
public abstract void enable()
```
    Enables the breakpoint.
  - getValidity
```
public final Breakpoint.VALIDITY getValidity()
```
    Get the validity of this breakpoint.
    
    Returns:
    
    The breakpoint validity.
  - getValidityMessage
```
public final String getValidityMessage()
```
    Get the message describing the current validity. For invalid breakpoints this should describe the reason why it is invalid.
    Intended for use by ui implementation code, NodeModel.getShortDescription(), for example.
    
    Returns:
    
    The validity message.
  - setValidity
```
protected final void setValidity(Breakpoint.VALIDITY validity,
                                 String reason)
```
    Set the validity of this breakpoint.
    
    Parameters:
    
    validity - The new breakpoint validity.
    
    reason - The message describing why is this validity being set, or null.
  - getHitCountFilter
```
public final int getHitCountFilter()
```
    Get the hit count filter.
    
    Returns:
    
    a positive hit count filter, or zero when no hit count filter is set.
  - getHitCountFilteringStyle
```
public final Breakpoint.HIT_COUNT_FILTERING_STYLE getHitCountFilteringStyle()
```
    Get the style of hit count filtering.
    
    Returns:
    
    the style of hit count filtering, or null when no count filter is set.
  - setHitCountFilter
```
public final void setHitCountFilter(int hitCountFilter,
                                    Breakpoint.HIT_COUNT_FILTERING_STYLE hitCountFilteringStyle)
```
    Set the hit count filter and the style of filtering.
    
    Parameters:
    
    hitCountFilter - a positive hit count filter, or zero to unset the filter.
    
    hitCountFilteringStyle - the style of hit count filtering. Can be null only when hitCountFilter == 0.
  - getGroupName
```
public String getGroupName()
```
    Get the name of a user-created group for this breakpoint.
  - setGroupName
```
public void setGroupName(String newGroupName)
```
    Set the name of a user-created group for this breakpoint.
  - getGroupProperties
```
public Breakpoint.GroupProperties getGroupProperties()
```
    Get group properties of the breakpoint. These are implementation-defined group properties as opposed to Breakpoint.getGroupName(), which returns user-defined group name.
    These properties are used by the Breakpoint Window to show a tree hierarchy of groups and associated breakpoints. Implementation should fire Breakpoint.PROP_GROUP_PROPERTIES event when the group properties change.
    
    Returns:
    
    Breakpoint.GroupProperties or null when no group properties are defined.
    
    Since:
    
    1.25
  - canHaveDependentBreakpoints
```
public boolean canHaveDependentBreakpoints()
```
    Determines if the breakpoint supports dependent breakpoints. If true, get/setBreakpointsToEnable/Disable methods can be used to get or set dependent breakpoints. If false, the methods throw an UnsupportedOperationException.
    
    Returns:
    
    true if the dependent breakpoints are supported, false otherwise.
    
    Since:
    
    1.35
  - getBreakpointsToEnable
```
@NonNull
public Set<Breakpoint> getBreakpointsToEnable()
```
    Get the set of breakpoints that will be enabled after this breakpoint is hit.
    Not all breakpoint implementations honor dependent breakpoints. Use Breakpoint.canHaveDependentBreakpoints() to determine if the operation is supported.
    
    Returns:
    
    The set of breakpoints.
    
    Throws:
    
    UnsupportedOperationException - if the breakpoint does not support dependent breakpoints - see Breakpoint.canHaveDependentBreakpoints().
    
    Since:
    
    1.35
  - getBreakpointsToDisable
```
@NonNull
public Set<Breakpoint> getBreakpointsToDisable()
```
    Get the set of breakpoints that will be disabled after this breakpoint is hit.
    Not all breakpoint implementations honor dependent breakpoints. Use Breakpoint.canHaveDependentBreakpoints() to determine if the operation is supported.
    
    Returns:
    
    The set of breakpoints.
    
    Throws:
    
    UnsupportedOperationException - if the breakpoint does not support dependent breakpoints - see Breakpoint.canHaveDependentBreakpoints().
    
    Since:
    
    1.35
  - setBreakpointsToEnable
```
public void setBreakpointsToEnable(@NonNull
                                   Set<Breakpoint> breakpointsToEnable)
```
    Set the set of breakpoints that will be enabled after this breakpoint is hit.
    Not all breakpoint implementations honor dependent breakpoints. Use Breakpoint.canHaveDependentBreakpoints() to determine if the operation is supported.
    
    Parameters:
    
    breakpointsToEnable - The set of breakpoints.
    
    Throws:
    
    UnsupportedOperationException - if the breakpoint does not support dependent breakpoints - see Breakpoint.canHaveDependentBreakpoints().
    
    Since:
    
    1.35
  - setBreakpointsToDisable
```
public void setBreakpointsToDisable(@NonNull
                                    Set<Breakpoint> breakpointsToDisable)
```
    Set the set of breakpoints that will be disabled after this breakpoint is hit.
    Not all breakpoint implementations honor dependent breakpoints. Use Breakpoint.canHaveDependentBreakpoints() to determine if the operation is supported.
    
    Parameters:
    
    breakpointsToEnable - The set of breakpoints.
    
    Throws:
    
    UnsupportedOperationException - if the breakpoint does not support dependent breakpoints - see Breakpoint.canHaveDependentBreakpoints().
    
    Since:
    
    1.35
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Add a listener to property changes.
    
    Parameters:
    
    listener - the listener to add
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Remove a listener to property changes.
    
    Parameters:
    
    listener - the listener to remove
  - addPropertyChangeListener
```
public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener l)
```
    Adds a property change listener.
    
    Parameters:
    
    propertyName - a name of property to listen on
    
    l - the listener to add
  - removePropertyChangeListener
```
public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener l)
```
    Removes a property change listener.
    
    Parameters:
    
    propertyName - a name of property to stop listening on
    
    l - the listener to remove
  - firePropertyChange
```
protected void firePropertyChange(String name,
                                  Object o,
                                  Object n)
```
    Fire property change.
    
    Parameters:
    
    name - name of property
    
    o - old value of property
    
    n - new value of property

Class Breakpoint

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_ENABLED

PROP_DISPOSED

PROP_GROUP_NAME

PROP_GROUP_PROPERTIES

PROP_VALIDITY

PROP_HIT_COUNT_FILTER

Constructor Detail

Breakpoint

Method Detail

dispose

isEnabled

disable

enable

getValidity

getValidityMessage

setValidity

getHitCountFilter

getHitCountFilteringStyle

setHitCountFilter

getGroupName

setGroupName

getGroupProperties

canHaveDependentBreakpoints

getBreakpointsToEnable

getBreakpointsToDisable

setBreakpointsToEnable

setBreakpointsToDisable

addPropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

firePropertyChange