Package com.pnfsoftware.jeb.core.units
Interface IMetadataGroup
- All Known Implementing Classes:
AbstractMetadataGroup
,AddressPrefixMetadataGroup
,MetadataGroup
Definition of a group of metadata objects.
-
Method Summary
Modifier and TypeMethodDescriptionGet a read-only map of all the key-value pairs of metadata items contained in this group.Get the piece of metadata associated with the provided address.getData
(String address, AddressConversionPrecision precision) Get the piece of metadata associated with the provided address.getName()
Get the group name.Retrieve the list of addresses that represent the start/change of a section, null if none.getType()
Get the group type.boolean
Set or remove the piece of metadata associated with the given address.
-
Method Details
-
getName
String getName()Get the group name.- Returns:
-
getType
MetadataGroupType getType()Get the group type.- Returns:
-
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
-
getData
Get the piece of metadata associated with the provided address.- Parameters:
address
- address- Returns:
- the data at address, null if none
-
getData
Get the piece of metadata associated with the provided address.- Parameters:
address
- addressprecision
- precision of the input address.AddressConversionPrecision.COARSE
will use raw references (may fasten result)- Returns:
- the data at address, null if none
-
setData
Set or remove the piece of metadata associated with the given address.- Parameters:
address
- addressdata
- metadata, use null to remove- Returns:
- true if the operation succeeded; false otherwise (eg, the operation is not supported)
-
getSectionAnchorIds
Retrieve the list of addresses that represent the start/change of a section, null if none.- Returns:
- the list of addresses
-