Package ghidra.trace.database.bookmark

Class DBTraceBookmarkSpace

java.lang.Object

ghidra.trace.database.bookmark.DBTraceBookmarkSpace

All Implemented Interfaces:

DBTraceSpaceBased, TraceBookmarkOperations, TraceBookmarkSpace, TraceSpaceMixin

public class DBTraceBookmarkSpace
extends Object
implements TraceBookmarkSpace, DBTraceSpaceBased

Field Summary

Fields

Modifier and Type	Field	Description
protected final DBTraceAddressSnapRangePropertyMapSpace<DBTraceBookmark,DBTraceBookmark>	bookmarkMapSpace
protected final DBCachedObjectIndex<String,DBTraceBookmark>	bookmarksByTypeName
protected final Collection<DBTraceBookmark>	bookmarkView
protected final ReadWriteLock	lock
protected final DBTraceBookmarkManager	manager
protected final AddressSpace	space
protected final DBTrace	trace

Constructor Summary

Constructors

Constructor	Description
DBTraceBookmarkSpace(DBTraceBookmarkManager manager, AddressSpace space)

Method Summary

Modifier and Type	Method	Description
DBTraceBookmark	addBookmark(Lifespan lifespan, Address address, TraceBookmarkType type, String category, String comment)	Add a bookmark at the given location.
protected DBTraceBookmarkType	assertInTrace(TraceBookmarkType type)
AddressSpace	getAddressSpace()	Get the object's address space
Collection<DBTraceBookmark>	getAllBookmarks()
Iterable<DBTraceBookmark>	getBookmarksAt(long snap, Address address)
Collection<DBTraceBookmark>	getBookmarksByType(String typeName)
Iterable<DBTraceBookmark>	getBookmarksEnclosed(Lifespan lifespan, AddressRange range)
Iterable<DBTraceBookmark>	getBookmarksIntersecting(Lifespan lifespan, AddressRange range)
Set<String>	getCategoriesForType(TraceBookmarkType type)	Get all the categories used for a given type
Trace	getTrace()	Get the trace containing the object
void	invalidateCache()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.trace.database.space.DBTraceSpaceBased

assertInSpace, assertInSpace, explainLanguages, isMySpace, toAddress, toOverlay

Methods inherited from interface ghidra.trace.model.bookmark.TraceBookmarkSpace

addBookmark, getBookmarksEnclosed, getBookmarksIntersecting

Methods inherited from interface ghidra.trace.util.TraceSpaceMixin

getFrameLevel, getThread

Field Details

manager

protected final DBTraceBookmarkManager manager

lock

protected final ReadWriteLock lock

trace

protected final DBTrace trace

space

protected final AddressSpace space

bookmarkMapSpace

protected final DBTraceAddressSnapRangePropertyMapSpace<DBTraceBookmark,DBTraceBookmark> bookmarkMapSpace

bookmarksByTypeName

protected final DBCachedObjectIndex<String,DBTraceBookmark> bookmarksByTypeName

bookmarkView

protected final Collection<DBTraceBookmark> bookmarkView

Constructor Details

DBTraceBookmarkSpace

public DBTraceBookmarkSpace(DBTraceBookmarkManager manager,
 AddressSpace space)
                     throws VersionException,
IOException

Throws:

VersionException

IOException

Method Details

getTrace

public Trace getTrace()

Description copied from interface: TraceSpaceMixin

Get the trace containing the object

Specified by:

getTrace in interface TraceBookmarkSpace

Specified by:

getTrace in interface TraceSpaceMixin

Returns:

the trace

getAddressSpace

public AddressSpace getAddressSpace()

Description copied from interface: TraceSpaceMixin

Get the object's address space

Specified by:

getAddressSpace in interface TraceBookmarkSpace

Specified by:

getAddressSpace in interface TraceSpaceMixin

Returns:

the address space

assertInTrace

protected DBTraceBookmarkType assertInTrace(TraceBookmarkType type)

getCategoriesForType

public Set<String> getCategoriesForType(TraceBookmarkType type)

Description copied from interface: TraceBookmarkOperations

Get all the categories used for a given type

Specified by:

getCategoriesForType in interface TraceBookmarkOperations

Parameters:

type - the bookmark type

Returns:

the set of categories

addBookmark

public DBTraceBookmark addBookmark(Lifespan lifespan,
 Address address,
 TraceBookmarkType type,
 String category,
 String comment)

Description copied from interface: TraceBookmarkOperations

Add a bookmark at the given location. The category need not be created explicitly beforehand. It will be created implicitly if it does not already exist.

Specified by:

addBookmark in interface TraceBookmarkOperations

Parameters:

lifespan - the span of snaps to bookmark

address - the address to bookmark

type - the type of the bookmark

category - a category for the bookmark

comment - a comment to add to the bookmark

Returns:

the new bookmark

getAllBookmarks

public Collection<DBTraceBookmark> getAllBookmarks()

Specified by:

getAllBookmarks in interface TraceBookmarkOperations

getBookmarksAt

public Iterable<DBTraceBookmark> getBookmarksAt(long snap,
 Address address)

Specified by:

getBookmarksAt in interface TraceBookmarkOperations

getBookmarksEnclosed

public Iterable<DBTraceBookmark> getBookmarksEnclosed(Lifespan lifespan,
 AddressRange range)

Specified by:

getBookmarksEnclosed in interface TraceBookmarkOperations

getBookmarksIntersecting

public Iterable<DBTraceBookmark> getBookmarksIntersecting(Lifespan lifespan,
 AddressRange range)

Specified by:

getBookmarksIntersecting in interface TraceBookmarkOperations

getBookmarksByType

public Collection<DBTraceBookmark> getBookmarksByType(String typeName)

invalidateCache

public void invalidateCache()

Specified by:

invalidateCache in interface DBTraceSpaceBased