Package ghidra.features.base.memsearch.matcher

Class UserInputByteMatcher

java.lang.Object

ghidra.features.base.memsearch.matcher.UserInputByteMatcher

All Implemented Interfaces:

ByteMatcher<SearchData>

Direct Known Subclasses:

InvalidByteMatcher, MaskedByteSequenceByteMatcher, RegExByteMatcher

public abstract class UserInputByteMatcher
extends Object
implements ByteMatcher<SearchData>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SearchData	searchData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserInputByteMatcher(String name, String input, SearchSettings settings)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
abstract String	getDescription()	Returns a description of what this byte matcher matches.
String	getInput()
String	getName()	Returns the name of this byte matcher..
SearchData	getSearchData()
SearchSettings	getSettings()
abstract String	getToolTip()	Returns additional information about this byte matcher.
int	hashCode()
boolean	isValidInput()	Returns true if this byte matcher has valid (but possibly incomplete) input text.
boolean	isValidSearch()	Returns true if this byte matcher is valid and can be used to perform a search.
abstract Iterable<Match<SearchData>>	match(ExtendedByteSequence bytes)	Returns an Iterable for returning matches within the given byte sequence.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

searchData

protected final SearchData searchData

Constructor Details

UserInputByteMatcher

protected UserInputByteMatcher(String name,
 String input,
 SearchSettings settings)

Method Details

getName

public String getName()

Returns the name of this byte matcher..

Returns:

the name of this byte matcher.

match

public abstract Iterable<Match<SearchData>> match(ExtendedByteSequence bytes)

Returns an Iterable for returning matches within the given byte sequence.

Specified by:

match in interface ByteMatcher<SearchData>

Parameters:

bytes - the byte sequence to search

Returns:

an iterable for return matches in the given sequence

getDescription

public abstract String getDescription()

Returns a description of what this byte matcher matches. (Typically a sequence of bytes)

Specified by:

getDescription in interface ByteMatcher<SearchData>

Returns:

a description of what this byte matcher matches

getToolTip

public abstract String getToolTip()

Returns additional information about this byte matcher. (Typically the mask bytes)

Returns:

additional information about this byte matcher

isValidSearch

public boolean isValidSearch()

Returns true if this byte matcher is valid and can be used to perform a search. If false, the description will return an error message explaining why this byte matcher is invalid.

Returns:

true if this byte matcher is valid and can be used to perform a search.

isValidInput

public boolean isValidInput()

Returns true if this byte matcher has valid (but possibly incomplete) input text. For example, when entering decimal values, the input could be just "-" as the user starts to enter a negative number. In this case the input is valid, but the isValidSearch() would return false.

Returns:

true if this byte matcher has valid text

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSettings

public SearchSettings getSettings()

getInput

public String getInput()

getSearchData

public SearchData getSearchData()