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
-
-
Method Summary
All Methods Instance Methods Concrete Methods 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 databaseFunctionTag
getFunctionTag(long id)
Returns the function tag with the given database idFunctionTag
getFunctionTag(java.lang.String name)
Returns the function tag with the given nameDBRecord
getTagRecord(long id)
int
getUseCount(FunctionTag tag)
Returns the number of times the given tag has been applied to a functionboolean
isTagAssigned(java.lang.String name)
Returns true if the given tag is assigned to a functionvoid
setProgram(Program program)
-
-
-
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 interfaceErrorHandler
-
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 interfaceFunctionTagManager
- 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 interfaceFunctionTagManager
- 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 interfaceFunctionTagManager
- 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 interfaceFunctionTagManager
- Parameters:
name
- the tag namecomment
- 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 interfaceFunctionTagManager
- 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 interfaceFunctionTagManager
- Parameters:
tag
- the tag- Returns:
- the count
-
-