Package ghidra.debug.api.breakpoint

Enum Class LogicalBreakpoint.Consistency

java.lang.Object

java.lang.Enum<LogicalBreakpoint.Consistency>

ghidra.debug.api.breakpoint.LogicalBreakpoint.Consistency

All Implemented Interfaces:

Serializable, Comparable<LogicalBreakpoint.Consistency>, Constable

Enclosing interface:

LogicalBreakpoint

public static enum LogicalBreakpoint.Consistency
extends Enum<LogicalBreakpoint.Consistency>

The consistency of a logical breakpoint

When operating as designed, all breakpoints should be in the NORMAL state. This indicates that the breakpoint's bookmark and all trace locations agree on the mode. Exceptions do happen, and they should be indicated to the user:

If the breakpoint is a lone breakpoint, meaning Ghidra cannot determine to what program it belongs, then the breakpoint is always INCONSISTENT, because Ghidra uses program bookmarks to save breakpoints.

If the breakpoint is mapped, meaning Ghidra can determine to what program it belongs and at what address, but it is not bookmarked, then the breakpoint is INCONSISTENT. If it is bookmarked, but the bookmark disagrees, then the breakpoint is INCONSISTENT. A breakpoint that is bookmarked but has no trace locations, or is missing from any participating trace, is INEFFECTIVE.

Implementation Notes:

These are ordered by priority, highest last.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCONSISTENT	has a trace location but is not bookmarked, or the bookmark disagrees
INEFFECTIVE	has a bookmark but one or more trace locations is missing
NORMAL	the bookmark and locations all agree

Method Summary

Modifier and Type	Method	Description
LogicalBreakpoint.Consistency	sameAddress(LogicalBreakpoint.Consistency that)
static LogicalBreakpoint.Consistency	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LogicalBreakpoint.Consistency[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORMAL

public static final LogicalBreakpoint.Consistency NORMAL

the bookmark and locations all agree

INEFFECTIVE

public static final LogicalBreakpoint.Consistency INEFFECTIVE

has a bookmark but one or more trace locations is missing

INCONSISTENT

public static final LogicalBreakpoint.Consistency INCONSISTENT

has a trace location but is not bookmarked, or the bookmark disagrees

Method Details

values

public static LogicalBreakpoint.Consistency[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LogicalBreakpoint.Consistency valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

sameAddress

public LogicalBreakpoint.Consistency sameAddress(LogicalBreakpoint.Consistency that)