# Class: com.pnfsoftware.jeb.core.BookmarkManager

Bookmark manager used by JEB projects.

## Constructor: BookmarkManager

Description: Create an empty bookmark manager.

## Method: get
- parameter: `unit`, type: `com.pnfsoftware.jeb.core.units.IUnit`
- parameter: `address`, type: `java.lang.String`
- return type: `java.lang.String`

Description: Retrieve a bookmark.
parameter: unit: bookmarked unit
parameter: address: bookmarked address, or null for a unit\-level bookmark
return: the bookmark description, or null if no bookmark exists

## Method: get
- parameter: `unit`, type: `com.pnfsoftware.jeb.core.units.IUnit`
- return type: `java.util.Collection<com.pnfsoftware.jeb.core.BookmarkManager.Bookmark>`

Description: Retrieve all bookmarks defined for a unit.
parameter: unit: target unit
return: bookmarks for the unit, or an empty collection if none exist

## Method: getAll
- return type: `java.util.List<com.pnfsoftware.jeb.core.BookmarkManager.Bookmark>`

Description: Retrieve every bookmark managed by this instance.
return: all bookmarks, possibly empty

## Method: onEvent
- parameter: `e`, type: `com.pnfsoftware.jeb.util.events.IEvent`

Description: React to project events in order to clean up bookmarks for destroyed units.
parameter: e: event to process

## Method: remove
- parameter: `unit`, type: `com.pnfsoftware.jeb.core.units.IUnit`
- parameter: `address`, type: `java.lang.String`
- return type: `boolean`

Description: Remove a bookmark from a unit or unit address.
parameter: unit: target unit
parameter: address: bookmarked address, or null for a unit\-level bookmark
return: true if a bookmark was removed

## Method: remove
- parameter: `unit`, type: `com.pnfsoftware.jeb.core.units.IUnit`
- return type: `boolean`

Description: Remove all bookmarks associated with a unit.
parameter: unit: target unit
return: true if at least one bookmark existed and was removed

## Method: set
- parameter: `unit`, type: `com.pnfsoftware.jeb.core.units.IUnit`
- parameter: `address`, type: `java.lang.String`
- parameter: `description`, type: `java.lang.String`

Description: Add or update a bookmark. A meta\-comment is auto\-generated.
parameter: unit: mandatory
parameter: address: an address, as defined in [IAddressableUnit](IAddressableUnit); null is accepted as well            to bookmark the unit as a whole, whether it be addressable or not
parameter: description: non\-null description

## Method: set
- parameter: `unit`, type: `com.pnfsoftware.jeb.core.units.IUnit`
- parameter: `address`, type: `java.lang.String`
- parameter: `description`, type: `java.lang.String`
- parameter: `doNotGenerateMetaComments`, type: `boolean`

Description: Add or update a bookmark.
parameter: unit: mandatory
parameter: address: an address, as defined in [IAddressableUnit](IAddressableUnit); null is accepted as well            to bookmark the unit as a whole, whether it be addressable or not
parameter: description: non\-null description
parameter: doNotGenerateMetaComments: if true, no associated meta\-comment with the flag            `COMMENT_FLAG_FAVORITE` will be generated

