Package ghidra.program.util
Class EolCommentFieldLocation
- java.lang.Object
-
- ghidra.program.util.ProgramLocation
-
- ghidra.program.util.CodeUnitLocation
-
- ghidra.program.util.CommentFieldLocation
-
- ghidra.program.util.EolCommentFieldLocation
-
- All Implemented Interfaces:
java.lang.Comparable<ProgramLocation>
public class EolCommentFieldLocation extends CommentFieldLocation
TheEolCommentFieldLocation
class contains specific location information within the EOL comment field of a CodeUnitLocation object.
-
-
Field Summary
-
Fields inherited from class ghidra.program.util.CommentFieldLocation
comment, type
-
Fields inherited from class ghidra.program.util.ProgramLocation
addr, program, refAddr
-
-
Constructor Summary
Constructors Constructor Description EolCommentFieldLocation()
Default constructor needed for restoring an end-of-line field location from XML.EolCommentFieldLocation(Program program, Address addr, int[] componentPath, java.lang.String[] comment, int displayableCommentRow, int charOffset, int currentCommentRow)
Construct a new EolCommentFieldLocation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
int
getCurrentCommentRow()
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.CommentFieldLocation
getComment, getCommentType, validateType
-
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
-
-
-
-
Constructor Detail
-
EolCommentFieldLocation
public EolCommentFieldLocation(Program program, Address addr, int[] componentPath, java.lang.String[] comment, int displayableCommentRow, int charOffset, int currentCommentRow)
Construct a new EolCommentFieldLocation.- Parameters:
program
- the program of the locationaddr
- the address of the codeunit.componentPath
- the componentPath of the codeUnitcomment
- comment text for the particular comment indicated by the address, subtype, and reference address.displayableCommentRow
- the line within the Eol comment as displayed.charOffset
- the character position on the line within the comment line.currentCommentRow
- the row index relative to the beginning of the End of Line comment as displayed in the Eol comment field.
-
EolCommentFieldLocation
public EolCommentFieldLocation()
Default constructor needed for restoring an end-of-line field location from XML.
-
-
Method Detail
-
getCurrentCommentRow
public int getCurrentCommentRow()
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classCommentFieldLocation
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classCommentFieldLocation
-
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 classCommentFieldLocation
- Parameters:
p
- program to restore fromobj
- 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 classCommentFieldLocation
- Parameters:
obj
- the save state object for saving the location
-
toString
public java.lang.String toString()
Description copied from class:CommentFieldLocation
Returns a String representation of this location.- Overrides:
toString
in classCommentFieldLocation
-
-