Summary:
Methods
| [Expand All]
public
interface
IMetadataGroup
| com.pnfsoftware.jeb.core.units.IMetadataGroup |
 Known Indirect Subclasses
|
Class Overview
Definition of a group of metadata objects.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract Map<String, Object> |
getAllData()
Get a read-only map of all the key-value pairs of metadata items contained in this group.
| ||||||||||
| abstract Object |
getData(String address)
Get the piece of metadata associated with the provided address.
| ||||||||||
| abstract Object |
getData(String address, AddressConversionPrecision precision)
Get the piece of metadata associated with the provided address.
| ||||||||||
| abstract String |
getName()
Get the group name.
| ||||||||||
| abstract List<String> |
getSectionAnchorIds()
Retrieve the list of addresses that represent the start/change of a section, null if none.
| ||||||||||
| abstract MetadataGroupType |
getType()
Get the group type.
| ||||||||||
| abstract boolean |
setData(String address, Object data)
Set or remove the piece of metadata associated with the given address.
| ||||||||||
Public Methods
public abstract Map<String, Object> getAllData ()
Get a read-only map of all the key-value pairs of metadata items contained in this group. Not all groups may be able to provide this functionality. If so, this method should return null.
Returns
- a map of key-value pairs, possibly empty; if the operation is not supported, null is returned
public abstract Object getData (String address)
Get the piece of metadata associated with the provided address.
Parameters
| address | address |
|---|
Returns
- the data at address, null if none
public abstract Object getData (String address, AddressConversionPrecision precision)
Get the piece of metadata associated with the provided address.
Parameters
| address | address |
|---|---|
| precision | precision of the input address. COARSE
will use raw references (may fasten result) |
Returns
- the data at address, null if none
public abstract String getName ()
Get the group name.
public abstract List<String> getSectionAnchorIds ()
Retrieve the list of addresses that represent the start/change of a section, null if none.
Returns
- the list of addresses
public abstract boolean setData (String address, Object data)
Set or remove the piece of metadata associated with the given address.
Parameters
| address | address |
|---|---|
| data | metadata, use null to remove |
Returns
- true if the operation succeeded; false otherwise (eg, the operation is not supported)