Package ghidra.program.database.properties

Class StringPropertyMapDB

java.lang.Object

ghidra.program.database.properties.PropertyMapDB

ghidra.program.database.properties.StringPropertyMapDB

All Implemented Interfaces:

PropertyMap, StringPropertyMap

public class StringPropertyMapDB
extends PropertyMapDB
implements StringPropertyMap

Property manager that deals with properties that are of String type and stored with a database table.

Field Summary

Fields inherited from class ghidra.program.database.properties.PropertyMapDB

addrMap, cache, changeMgr, dbHandle, DEFAULT_CACHE_SIZE, errHandler, lock, name, NO_SCHEMA_FIELD_CLASSES, NO_SCHEMA_FIELD_NAMES, PROPERTY_VALUE_COL, propertyTable, schema, SCHEMA_FIELD_NAMES

Constructor Summary

Constructors

Constructor	Description
StringPropertyMapDB(DBHandle dbHandle, int openMode, ErrorHandler errHandler, ChangeManager changeMgr, AddressMap addrMap, java.lang.String name, TaskMonitor monitor)	Construct an String property map.

Method Summary

Modifier and Type	Method	Description
void	add(Address addr, java.lang.String value)	Add a String value at the specified address.
void	applyValue(PropertyVisitor visitor, Address addr)	Applies a property value at the indicated address without knowing its type (String, int, long, etc.) by using the property visitor.
java.lang.Object	getObject(Address addr)	Returns the property value stored at the specified address or null if no property found.
java.lang.String	getString(Address addr)	Get the String value at the given address.

Methods inherited from class ghidra.program.database.properties.PropertyMapDB

createTable, delete, getAddressKeyIterator, getAddressKeyIterator, getAddressKeyIterator, getFirstPropertyAddress, getLastPropertyAddress, getName, getNextPropertyAddress, getPreviousPropertyAddress, getPropertyIterator, getPropertyIterator, getPropertyIterator, getPropertyIterator, getPropertyIterator, getPropertyIterator, getSize, getTableName, getTableName, hasProperty, intersects, intersects, invalidateCache, moveRange, remove, removeRange, setCacheSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.program.model.util.PropertyMap

getFirstPropertyAddress, getLastPropertyAddress, getName, getNextPropertyAddress, getPreviousPropertyAddress, getPropertyIterator, getPropertyIterator, getPropertyIterator, getPropertyIterator, getPropertyIterator, getPropertyIterator, getSize, hasProperty, intersects, intersects, moveRange, remove, removeRange

Constructor Detail

StringPropertyMapDB

public StringPropertyMapDB(DBHandle dbHandle,
                           int openMode,
                           ErrorHandler errHandler,
                           ChangeManager changeMgr,
                           AddressMap addrMap,
                           java.lang.String name,
                           TaskMonitor monitor)
                    throws VersionException,
                           CancelledException,
                           java.io.IOException

Construct an String property map.

Parameters:

dbHandle - database handle.

openMode - the mode that the program was openned in.

errHandler - database error handler.

changeMgr - change manager for event notification

addrMap - address map.

name - property name.

monitor - progress monitor that is only used when upgrading

Throws:

VersionException - if the database version is not the expected version.

CancelledException - if the user cancels the upgrade operation.

java.io.IOException - if a database io error occurs.

Method Detail

add

public void add(Address addr,
                java.lang.String value)

Description copied from interface: StringPropertyMap

Add a String value at the specified address.

Specified by:

add in interface StringPropertyMap

Parameters:

addr - address for the property

value - value of the property

See Also:

StringPropertyMap.add(ghidra.program.model.address.Address, java.lang.String)

getString

public java.lang.String getString(Address addr)

Description copied from interface: StringPropertyMap

Get the String value at the given address.

Specified by:

getString in interface StringPropertyMap

Parameters:

addr - the address from where to get the String value

Returns:

String or null if property not found at addr.

See Also:

StringPropertyMap.getString(ghidra.program.model.address.Address)

getObject

public java.lang.Object getObject(Address addr)

Description copied from interface: PropertyMap

Returns the property value stored at the specified address or null if no property found.

Specified by:

getObject in interface PropertyMap

Parameters:

addr - property address

Returns:

property value

See Also:

PropertyMap.getObject(ghidra.program.model.address.Address)

applyValue

public void applyValue(PropertyVisitor visitor,
                       Address addr)

Description copied from interface: PropertyMap

Applies a property value at the indicated address without knowing its type (String, int, long, etc.) by using the property visitor.

Specified by:

applyValue in interface PropertyMap

Parameters:

visitor - the property visitor that lets you apply the property without knowing its specific type ahead of time.

addr - the address where the property is to be applied.

See Also:

PropertyMap.applyValue(ghidra.util.prop.PropertyVisitor, ghidra.program.model.address.Address)