net.openhft.chronicle.hash

Interface ChecksumEntry

All Known Implementing Classes:

HashEntryStages, MapEntryStages, ReplicatedMapEntryStages

public interface ChecksumEntry

Abstracts entries of hash containers, created by ChronicleHashBuilders with ChronicleHashBuilder.checksumEntries(boolean) configured to true. There is no method that returns ChecksumEntry, MapEntry or SetEntry could be casted to ChecksumEntry to access it's methods.

See Entry checksums section in the Chronicle Map tutorial for usage examples of this interface.

Method Summary

Modifier and Type	Method and Description
boolean	checkSum() Computes checksum from the entry bytes and checks whether it is equal to the stored checksum.
void	updateChecksum() Re-computes and stores checksum for the entry.

Method Detail

updateChecksum

void updateChecksum()

Re-computes and stores checksum for the entry. This method shouldn't be called before or after ordinary operations like MapAbsentEntry.doInsert(Data), MapEntry.doReplaceValue(Data): it is performed automatically underneath. Call this method, only when value bytes was updated directly, for example though flyweight implementation of a value interface.

Throws:

UnsupportedOperationException - if checksums are not stored in the containing Chronicle Hash

RuntimeException - if the context of this entry is locked improperly, e. g. on the read level, that is not upgradable to the update level. Calling updateChecksum() method is enabled when at least update lock is held.

checkSum

boolean checkSum()

Computes checksum from the entry bytes and checks whether it is equal to the stored checksum.

Returns:

true if stored checksum equals to checksum computed from the entry bytes

Throws:

UnsupportedOperationException - if checksums are not stored in the containing Chronicle Hash

RuntimeException - if the context of this entry is locked improperly, e. g. on the read level, that is not upgradable to the update level. Calling checkSum() method is enabled when at least update lock is held.