Enum Class BpsSearchType

java.lang.Object

java.lang.Enum<BpsSearchType>

ghidra.util.bytesearch.bytepatternsearch.BpsSearchType

All Implemented Interfaces:

Serializable, Comparable<BpsSearchType>, Constable

public enum BpsSearchType
extends Enum<BpsSearchType>

This enum represents the type of search to be conducted as used by the Byte Pattern Searcher capability within Ghidra.

The design of the Byte Pattern Searcher and its supporting sub-capabilities and classes can be found in the "Search For Byte Patterns" page in the help viewer.

This enum manages the possible supported search types.

All BpsSearchItem objects will have a searchType which indicate how the BpsPattern items should be searched for. A complete discussion of all search types can be found in the "Search For Byte Patterns" page in the help viewer.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONSTANT_SEARCH	Constant Search: byte patterns to be found anywhere and in any order in the program.
FUNCTION_SEARCH	Function Search: byte patterns must all be found within the same function.
ORDERED_FUNCTION_SEARCH	Ordered Function Search: byte patterns must all be found within the same function and also be found in the same order as in the pattern file.
TABLE_SEARCH	Table Search: byte patterns represent a table and must be found in the same order as in the pattern file

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TABLE_SEARCH

public static final BpsSearchType TABLE_SEARCH

Table Search: byte patterns represent a table and must be found in the same order as in the pattern file

CONSTANT_SEARCH

public static final BpsSearchType CONSTANT_SEARCH

Constant Search: byte patterns to be found anywhere and in any order in the program.

FUNCTION_SEARCH

public static final BpsSearchType FUNCTION_SEARCH

Function Search: byte patterns must all be found within the same function.

ORDERED_FUNCTION_SEARCH

public static final BpsSearchType ORDERED_FUNCTION_SEARCH

Ordered Function Search: byte patterns must all be found within the same function and also be found in the same order as in the pattern file.

Method Details

values

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