Package ghidra.program.database.function
Class FunctionTagDB
- java.lang.Object
-
- ghidra.program.database.DatabaseObject
-
- ghidra.program.database.function.FunctionTagDB
-
- All Implemented Interfaces:
FunctionTag
,java.lang.Comparable<FunctionTag>
public class FunctionTagDB extends DatabaseObject implements FunctionTag
Database object forFunctionTagAdapter
objects.
-
-
Field Summary
-
Fields inherited from class ghidra.program.database.DatabaseObject
key
-
-
Constructor Summary
Constructors Constructor Description FunctionTagDB(FunctionTagManagerDB mgr, DBObjectCache<FunctionTagDB> cache, DBRecord record)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(FunctionTag otherTag)
void
delete()
Deletes this tag from the programboolean
equals(java.lang.Object obj)
java.lang.String
getComment()
Returns the tag commentlong
getId()
Returns the id of the itemjava.lang.String
getName()
Returns the tag nameint
hashCode()
protected boolean
refresh()
Tells the object to refresh its state from the database.protected boolean
refresh(DBRecord rec)
Tells the object to refresh its state from the database using the specified record if not null.void
setComment(java.lang.String comment)
Sets the comment for this tagvoid
setName(java.lang.String name)
Sets the name of the tagjava.lang.String
toString()
-
Methods inherited from class ghidra.program.database.DatabaseObject
checkDeleted, checkIsValid, checkIsValid, getKey, isDeleted, isInvalid, keyChanged, setInvalid, validate
-
-
-
-
Constructor Detail
-
FunctionTagDB
public FunctionTagDB(FunctionTagManagerDB mgr, DBObjectCache<FunctionTagDB> cache, DBRecord record)
-
-
Method Detail
-
getId
public long getId()
Description copied from interface:FunctionTag
Returns the id of the item- Specified by:
getId
in interfaceFunctionTag
- Returns:
- the id of the item
-
setComment
public void setComment(java.lang.String comment)
Description copied from interface:FunctionTag
Sets the comment for this tag- Specified by:
setComment
in interfaceFunctionTag
- Parameters:
comment
- the tag comment
-
setName
public void setName(java.lang.String name)
Description copied from interface:FunctionTag
Sets the name of the tag- Specified by:
setName
in interfaceFunctionTag
- Parameters:
name
- the tag name
-
getComment
public java.lang.String getComment()
Description copied from interface:FunctionTag
Returns the tag comment- Specified by:
getComment
in interfaceFunctionTag
- Returns:
- the tag comment
-
getName
public java.lang.String getName()
Description copied from interface:FunctionTag
Returns the tag name- Specified by:
getName
in interfaceFunctionTag
- Returns:
- the tag name
-
refresh
protected boolean refresh()
Description copied from class:DatabaseObject
Tells the object to refresh its state from the database.- Specified by:
refresh
in classDatabaseObject
- Returns:
- true if the object was able to refresh itself. Return false if the object was deleted. Objects that extend this class must implement a refresh method. If an object can never refresh itself, then it should always return false.
-
refresh
protected boolean refresh(DBRecord rec)
Description copied from class:DatabaseObject
Tells the object to refresh its state from the database using the specified record if not null. NOTE: The default implementation ignores the record and invokes refresh(). Implementations of this method must take care if multiple database tables are used since the record supplied could correspond to another object. In some cases it may be best not to override this method or ignore the record provided.- Overrides:
refresh
in classDatabaseObject
- Parameters:
rec
- valid record associated with object's key (optional, may be null to force record lookup or other refresh technique)- Returns:
- true if the object was able to refresh itself. Return false if record is null and object was deleted. Objects that extend this class must implement a refresh method. If an object can never refresh itself, then it should always return false.
-
delete
public void delete()
Description copied from interface:FunctionTag
Deletes this tag from the program- Specified by:
delete
in interfaceFunctionTag
-
compareTo
public int compareTo(FunctionTag otherTag)
- Specified by:
compareTo
in interfacejava.lang.Comparable<FunctionTag>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-