Package ghidra.program.util

Class SpacerFieldLocation

java.lang.Object

ghidra.program.util.ProgramLocation

ghidra.program.util.CodeUnitLocation

ghidra.program.util.SpacerFieldLocation

All Implemented Interfaces:

java.lang.Comparable<ProgramLocation>

public class SpacerFieldLocation
extends CodeUnitLocation

The SpacerFieldLocation class contains specific location information within a spacer field of a CodeUnitLocation object.

Field Summary

Fields inherited from class ghidra.program.util.ProgramLocation

addr, program, refAddr

Constructor Summary

Constructors

Constructor	Description
SpacerFieldLocation()	Should only be used by XML restoration.
SpacerFieldLocation(Program program, Address addr, int[] componentPath, int charOffset, java.lang.String text)	Construct a new SpacerFieldLocation.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getText()	Returns the text of the Spacer field containing this location.
int	hashCode()
void	restoreState(Program p, SaveState obj)	Restore this program location using the given program and save state object.
void	saveState(SaveState obj)	Save this program location to the given save state object.
java.lang.String	toString()	returns a String representation of this location.

Methods inherited from class ghidra.program.util.CodeUnitLocation

isValid

Methods inherited from class ghidra.program.util.ProgramLocation

compareAddr, compareTo, getAddress, getByteAddress, getCharOffset, getColumn, getComponentPath, getLocation, getProgram, getRefAddress, getRow

Methods inherited from class java.lang.Object

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

Constructor Detail

SpacerFieldLocation

public SpacerFieldLocation(Program program,
                           Address addr,
                           int[] componentPath,
                           int charOffset,
                           java.lang.String text)

Construct a new SpacerFieldLocation.

Parameters:

program - the program of the location

addr - the address of the codeunit.

componentPath - the componentPath of the codeUnit

charOffset - the character position on the row of the location.

text - the constant text in this spacer.

SpacerFieldLocation

public SpacerFieldLocation()

Should only be used by XML restoration.

Method Detail

getText

public java.lang.String getText()

Returns the text of the Spacer field containing this location.

toString

public java.lang.String toString()

returns a String representation of this location.

Overrides:

toString in class ProgramLocation

hashCode

public int hashCode()

Overrides:

hashCode in class ProgramLocation

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ProgramLocation

restoreState

public void restoreState(Program p,
                         SaveState obj)

Description copied from class: ProgramLocation

Restore this program location using the given program and save state object.

Overrides:

restoreState in class ProgramLocation

Parameters:

p - program to restore from

obj - the save state to restore from

saveState

public void saveState(SaveState obj)

Description copied from class: ProgramLocation

Save this program location to the given save state object.

Overrides:

saveState in class ProgramLocation

Parameters:

obj - the save state object for saving the location