Package ghidra.features.base.memsearch.bytesource

Enum Class EmptyByteSource

java.lang.Object

java.lang.Enum<EmptyByteSource>

ghidra.features.base.memsearch.bytesource.EmptyByteSource

All Implemented Interfaces:

AddressableByteSource, Serializable, Comparable<EmptyByteSource>, Constable

public enum EmptyByteSource
extends Enum<EmptyByteSource>
implements AddressableByteSource

Implementation for an empty AddressableByteSource

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
INSTANCE

Method Summary

Modifier and Type	Method	Description
int	getBytes(Address address, byte[] bytes, int length)	Retrieves the byte values for an address range.
List<SearchRegion>	getSearchableRegions()	Returns a list of memory regions where each region has an associated address set of valid addresses that can be read.
void	invalidate()	Invalidates any caching of byte values.
static EmptyByteSource	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmptyByteSource[]	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

INSTANCE

public static final EmptyByteSource INSTANCE

Method Details

values

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

getBytes

public int getBytes(Address address,
 byte[] bytes,
 int length)

Description copied from interface: AddressableByteSource

Retrieves the byte values for an address range.

Specified by:

getBytes in interface AddressableByteSource

Parameters:

address - The address of the first byte in the range

bytes - the byte array to store the retrieved byte values

length - the number of bytes to retrieve

Returns:

the number of bytes actually retrieved

getSearchableRegions

public List<SearchRegion> getSearchableRegions()

Description copied from interface: AddressableByteSource

Returns a list of memory regions where each region has an associated address set of valid addresses that can be read.

Specified by:

getSearchableRegions in interface AddressableByteSource

Returns:

a list of readable regions

invalidate

public void invalidate()

Description copied from interface: AddressableByteSource

Invalidates any caching of byte values. This intended to provide a hint in debugging scenario that we are about to issue a sequence of byte value requests where we are re-acquiring previous requested byte values to look for changes.

Specified by:

invalidate in interface AddressableByteSource