Package ghidra.program.model.listing

# Interface Bookmark

All Superinterfaces:
  `Comparable<Bookmark>`

All Known Subinterfaces:
  `TraceBookmark`

All Known Implementing Classes:
  `BookmarkDB`, `DBTraceBookmark`

public interface Bookmark extends Comparable<Bookmark>
Interface for bookmarks. Bookmarks are locations that are marked within the program so that they can be easily found.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Address`
  `getAddress()`
  Returns address at which this bookmark is applied.
  `String`
  `getCategory()`
  Returns bookmark category
  `String`
  `getComment()`
  Returns bookmark comment
  `long`
  `getId()`
  Returns the id of the bookmark.
  `BookmarkType`
  `getType()`
  Returns bookmark type object.
  `String`
  `getTypeString()`
  Returns bookmark type as a string
  `void`
  `set(String category, String comment)`
  Set the category and comment associated with a bookmark.

  ### Methods inherited from interface java.lang.Comparable

  `compareTo`

- ## Method Details

  - ### 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

    String getTypeString()
    Returns bookmark type as a string

  - ### getCategory

    String getCategory()
    Returns bookmark category

  - ### getComment

    String getComment()
    Returns bookmark comment

  - ### set

    void set(String category, String comment)
    Set the category and comment associated with a bookmark.
    Parameters:
      `category` - category
      `comment` - single line comment