Package ghidra.program.database.function

Class FunctionTagManagerDB

java.lang.Object

ghidra.program.database.function.FunctionTagManagerDB

All Implemented Interfaces:

ErrorHandler, FunctionTagManager

public class FunctionTagManagerDB
extends java.lang.Object
implements FunctionTagManager, ErrorHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected Lock	lock

Method Summary

Modifier and Type	Method	Description
FunctionTag	createFunctionTag(java.lang.String name, java.lang.String comment)	Creates a new function tag with the given attributes if one does not already exist.
void	dbError(java.io.IOException e)	Notification that an IO exception occurred.
java.util.List<? extends FunctionTag>	getAllFunctionTags()	Returns all function tags in the database
FunctionTag	getFunctionTag(long id)	Returns the function tag with the given database id
FunctionTag	getFunctionTag(java.lang.String name)	Returns the function tag with the given name
DBRecord	getTagRecord(long id)
int	getUseCount(FunctionTag tag)	Returns the number of times the given tag has been applied to a function
boolean	isTagAssigned(java.lang.String name)	Returns true if the given tag is assigned to a function
void	setProgram(Program program)

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected final Lock lock

Method Detail

setProgram

public void setProgram(Program program)

dbError

public void dbError(java.io.IOException e)

Description copied from interface: ErrorHandler

Notification that an IO exception occurred.

Specified by:

dbError in interface ErrorHandler

getFunctionTag

public FunctionTag getFunctionTag(java.lang.String name)

Description copied from interface: FunctionTagManager

Returns the function tag with the given name

Specified by:

getFunctionTag in interface FunctionTagManager

Parameters:

name - the tag name

Returns:

the function tag, or null if not found

getFunctionTag

public FunctionTag getFunctionTag(long id)

Description copied from interface: FunctionTagManager

Returns the function tag with the given database id

Specified by:

getFunctionTag in interface FunctionTagManager

Parameters:

id - the tags database id

Returns:

the function tag, or null if not found

isTagAssigned

public boolean isTagAssigned(java.lang.String name)

Description copied from interface: FunctionTagManager

Returns true if the given tag is assigned to a function

Specified by:

isTagAssigned in interface FunctionTagManager

Parameters:

name - the tag name

Returns:

true if assigned to a function

createFunctionTag

public FunctionTag createFunctionTag(java.lang.String name,
                                     java.lang.String comment)

Description copied from interface: FunctionTagManager

Creates a new function tag with the given attributes if one does not already exist. Otherwise, returns the existing tag.

Specified by:

createFunctionTag in interface FunctionTagManager

Parameters:

name - the tag name

comment - the comment associated with the tag (optional)

Returns:

the new function tag

getAllFunctionTags

public java.util.List<? extends FunctionTag> getAllFunctionTags()

Description copied from interface: FunctionTagManager

Returns all function tags in the database

Specified by:

getAllFunctionTags in interface FunctionTagManager

Returns:

list of function tags

getTagRecord

public DBRecord getTagRecord(long id)
                      throws java.io.IOException

Throws:

java.io.IOException

getUseCount

public int getUseCount(FunctionTag tag)

Description copied from interface: FunctionTagManager

Returns the number of times the given tag has been applied to a function

Specified by:

getUseCount in interface FunctionTagManager

Parameters:

tag - the tag

Returns:

the count