Package ghidra.debug.api.breakpoint

Enum Class LogicalBreakpoint.ProgramMode

java.lang.Object

java.lang.Enum<LogicalBreakpoint.ProgramMode>

ghidra.debug.api.breakpoint.LogicalBreakpoint.ProgramMode

All Implemented Interfaces:

Serializable, Comparable<LogicalBreakpoint.ProgramMode>, Constable

Enclosing interface:

LogicalBreakpoint

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

The state of a logical breakpoint's program bookmark

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
DISABLED	The breakpoint's program bookmark is disabled
ENABLED	The breakpoint's program bookmark is enabled
MISSING	The state when the program location applies, but no breakpoint is present there
NONE	A placeholder state when the program bookmark state is not applicable

Method Summary

Modifier and Type	Method	Description
abstract LogicalBreakpoint.State	combineTrace(LogicalBreakpoint.TraceMode traceMode, LogicalBreakpoint.Perspective perspective)	Compose the logical breakpoint state from the perspective of the program, given the composed state of its locations
static LogicalBreakpoint.ProgramMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LogicalBreakpoint.ProgramMode[]	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

NONE

public static final LogicalBreakpoint.ProgramMode NONE

A placeholder state when the program bookmark state is not applicable

MISSING

public static final LogicalBreakpoint.ProgramMode MISSING

The state when the program location applies, but no breakpoint is present there

This can happen when a breakpoint is placed directly in the debugger at a mapped address, but that breakpoint is not (yet) bookmarked in the mapped program.

ENABLED

public static final LogicalBreakpoint.ProgramMode ENABLED

The breakpoint's program bookmark is enabled

DISABLED

public static final LogicalBreakpoint.ProgramMode DISABLED

The breakpoint's program bookmark is disabled

Method Details

values

public static LogicalBreakpoint.ProgramMode[] 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.ProgramMode 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

combineTrace

public abstract LogicalBreakpoint.State combineTrace(LogicalBreakpoint.TraceMode traceMode,
 LogicalBreakpoint.Perspective perspective)

Compose the logical breakpoint state from the perspective of the program, given the composed state of its locations

This state is generally considered the state of the logical breakpoint. In other words, the program's perspective is the default.

Parameters:

traceMode - the mode of its locations

perspective - the perspective

Returns:

the logical state