Package ghidra.program.database.function

Class FunctionTagDB

java.lang.Object

ghidra.program.database.DatabaseObject

ghidra.program.database.function.FunctionTagDB

All Implemented Interfaces:

FunctionTag, Comparable<FunctionTag>

public class FunctionTagDB
extends DatabaseObject
implements FunctionTag

Database object for FunctionTagAdapter 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

Modifier and Type	Method	Description
int	compareTo(FunctionTag otherTag)
void	delete()	Deletes this tag from the program
boolean	equals(Object obj)
String	getComment()	Returns the tag comment
long	getId()	Returns the id of the item
String	getName()	Returns the tag name
int	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(String comment)	Sets the comment for this tag
void	setName(String name)	Sets the name of the tag
String	toString()

Methods inherited from class ghidra.program.database.DatabaseObject

checkDeleted, checkIsValid, checkIsValid, getKey, isDeleted, isInvalid, keyChanged, setDeleted, setInvalid, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FunctionTagDB

public FunctionTagDB(FunctionTagManagerDB mgr,
 DBObjectCache<FunctionTagDB> cache,
 DBRecord record)

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()

Description copied from class: DatabaseObject

Tells the object to refresh its state from the database.

Specified by:

refresh in class DatabaseObject

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 class DatabaseObject

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