Package com.pnfsoftware.jeb.core

Class BookmarkManager

java.lang.Object

com.pnfsoftware.jeb.core.BookmarkManager

All Implemented Interfaces:

IEventListener

@Ser
public class BookmarkManager
extends Object
implements IEventListener

Bookmark manager used by JEB projects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BookmarkManager.Bookmark	Definition of a bookmark.

Constructor Summary

Constructors

Constructor	Description
BookmarkManager()

Method Summary

Modifier and Type	Method	Description
Collection<BookmarkManager.Bookmark>	get(IUnit unit)
String	get(IUnit unit, String address)	Retrieve a bookmark.
List<BookmarkManager.Bookmark>	getAll()
void	onEvent(IEvent e)
boolean	remove(IUnit unit)
boolean	remove(IUnit unit, String address)
void	set(IUnit unit, String address, String description)	Add or update a bookmark.
void	set(IUnit unit, String address, String description, boolean doNotGenerateMetaComments)	Add or update a bookmark.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BookmarkManager

public BookmarkManager()

Method Details

onEvent

public void onEvent(IEvent e)

Specified by:

onEvent in interface IEventListener

set

public void set(IUnit unit,
 String address,
 String description)

Add or update a bookmark. A meta-comment is auto-generated.

Parameters:

unit - mandatory

address - an address, as defined in IAddressableUnit; null is accepted as well to bookmark the unit as a whole, whether it be addressable or not

description - non-null description

set

public void set(IUnit unit,
 String address,
 String description,
 boolean doNotGenerateMetaComments)

Add or update a bookmark.

Parameters:

unit - mandatory

address - an address, as defined in IAddressableUnit; null is accepted as well to bookmark the unit as a whole, whether it be addressable or not

description - non-null description

doNotGenerateMetaComments - if true, no associated meta-comment with the flag COMMENT_FLAG_FAVORITE will be generated

get

public String get(IUnit unit,
 String address)

Retrieve a bookmark.

Parameters:

unit -

address -

Returns:

get

public Collection<BookmarkManager.Bookmark> get(IUnit unit)

getAll

public List<BookmarkManager.Bookmark> getAll()

remove

public boolean remove(IUnit unit,
 String address)

remove

public boolean remove(IUnit unit)