Class FunctionTagDB

java.lang.Object
ghidra.program.database.DbObject
ghidra.program.database.function.FunctionTagDB
All Implemented Interfaces:
FunctionTag, Comparable<FunctionTag>
public class FunctionTagDB extends DbObject implements FunctionTag
Database object for FunctionTagAdapter objects.

  • Constructor Details

  • Method Details

    • getId

      public long getId()
      Description copied from interface: FunctionTag
      Returns the id of the item
      Specified by:
      getId in interface FunctionTag
      Returns:
      the id of the item

    • setComment

      public void setComment(String comment)
      Description copied from interface: FunctionTag
      Sets the comment for this tag
      Specified by:
      setComment in interface FunctionTag
      Parameters:
      comment - the tag comment

    • setName

      public void setName(String name)
      Description copied from interface: FunctionTag
      Sets the name of the tag
      Specified by:
      setName in interface FunctionTag
      Parameters:
      name - the tag name

    • getComment

      public String getComment()
      Description copied from interface: FunctionTag
      Returns the tag comment
      Specified by:
      getComment in interface FunctionTag
      Returns:
      the tag comment

    • getName

      public String getName()
      Description copied from interface: FunctionTag
      Returns the tag name
      Specified by:
      getName in interface FunctionTag
      Returns:
      the tag name

    • refresh

      protected boolean refresh(DBRecord rec)
      Description copied from class: DbObject
      Tells the object to refresh its state from the database using the specified record if provided. The record may be null and the object is generally expected to be able to retrieve its own record from the database as needed. Is is mostly passed as a parameter for efficiency to keep an object from having to look up its record when the client already has the record in hand such as when it is iterating over records.

      This method generally should not be called directly as it provides no recursion protection. Instead, most clients should call DbObject.refreshIfNeeded() instead which WILL provide recursion protection. If clients must call this method, they either need to provided their own recursion protection or be absolutely certain that recursive calls won't occur.

      Specified by:
      refresh in class DbObject
      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 interface FunctionTag

    • compareTo

      public int compareTo(FunctionTag otherTag)
      Specified by:
      compareTo in interface Comparable<FunctionTag>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object