Package ghidra.features.base.memsearch.bytesource

Enum Class ProgramSearchRegion

java.lang.Object

java.lang.Enum<ProgramSearchRegion>

ghidra.features.base.memsearch.bytesource.ProgramSearchRegion

All Implemented Interfaces:

SearchRegion, Serializable, Comparable<ProgramSearchRegion>, Constable

public enum ProgramSearchRegion
extends Enum<ProgramSearchRegion>
implements SearchRegion

An enum specifying the selectable regions within a Program that users can select for searching memory.

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
LOADED
OTHER

Field Summary

Fields

Modifier and Type	Field	Description
static final List<SearchRegion>	ALL

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a description of the region.
String	getName()	The name of the region.
static ProgramSearchRegion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProgramSearchRegion[]	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

Methods inherited from interface ghidra.features.base.memsearch.bytesource.SearchRegion

getAddresses, isDefault

Enum Constant Details

LOADED

public static final ProgramSearchRegion LOADED

OTHER

public static final ProgramSearchRegion OTHER

Field Details

ALL

public static final List<SearchRegion> ALL

Method Details

values

public static ProgramSearchRegion[] 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 ProgramSearchRegion 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

getName

public String getName()

Description copied from interface: SearchRegion

The name of the region.

Specified by:

getName in interface SearchRegion

Returns:

the name of the region

getDescription

public String getDescription()

Description copied from interface: SearchRegion

Returns a description of the region.

Specified by:

getDescription in interface SearchRegion

Returns:

a description of the region