Package ghidra.program.model.listing
Interface Bookmark
-
- All Superinterfaces:
java.lang.Comparable<Bookmark>
- All Known Implementing Classes:
BookmarkDB
public interface Bookmark extends java.lang.Comparable<Bookmark>
Interface for bookmarks. Bookmarks are locations that are marked within the program so that they can be easily found.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Address
getAddress()
Returns address at which this bookmark is applied.java.lang.String
getCategory()
Returns bookmark categoryjava.lang.String
getComment()
Returns bookmark commentlong
getId()
Returns the id of the bookmark.BookmarkType
getType()
Returns bookmark type object.java.lang.String
getTypeString()
Returns bookmark type as a stringvoid
set(java.lang.String category, java.lang.String comment)
Set the category and comment associated with a bookmark.
-
-
-
Method Detail
-
getId
long getId()
Returns the id of the bookmark.
-
getAddress
Address getAddress()
Returns address at which this bookmark is applied.
-
getType
BookmarkType getType()
Returns bookmark type object.
-
getTypeString
java.lang.String getTypeString()
Returns bookmark type as a string
-
getCategory
java.lang.String getCategory()
Returns bookmark category
-
getComment
java.lang.String getComment()
Returns bookmark comment
-
set
void set(java.lang.String category, java.lang.String comment)
Set the category and comment associated with a bookmark.- Parameters:
category
- categorycomment
- single line comment
-
-