Class MerkleTreeConfig
- All Implemented Interfaces:
DataSerializable
,IdentifiedDataSerializable
public class MerkleTreeConfig extends Object implements IdentifiedDataSerializable
A larger depth means that a data synchronization mechanism will be able to pinpoint a smaller subset of the data structure contents in which a change occurred. This causes the synchronization mechanism to be more efficient. On the other hand, a larger tree depth means the merkle tree will consume more memory.
A smaller depth means the data synchronization mechanism will have to transfer larger chunks of the data structure in which a possible change happened. On the other hand, a shallower tree consumes less memory. The depth must be between 2 and 27 (exclusive). The default depth is 10.
As the comparison mechanism is iterative, a larger depth will also prolong the duration of the comparison mechanism. Care must be taken to not have large tree depths if the latency of the comparison operation is high. The default depth is 10.
See https://en.wikipedia.org/wiki/Merkle_tree.
- Since:
- 3.11
-
Constructor Summary
Constructors Constructor Description MerkleTreeConfig()
MerkleTreeConfig(MerkleTreeConfig config)
Clones aMerkleTreeConfig
. -
Method Summary
Modifier and Type Method Description boolean
equals(Object o)
int
getClassId()
Returns type identifier for this class.int
getDepth()
Returns the depth of the merkle tree.int
getFactoryId()
Returns DataSerializableFactory factory ID for this class.int
hashCode()
boolean
isEnabled()
Returns if the merkle tree is enabled.void
readData(ObjectDataInput in)
Reads fields from the input streamMerkleTreeConfig
setDepth(int depth)
Sets the depth of the merkle tree.MerkleTreeConfig
setEnabled(boolean enabled)
Enables or disables the merkle tree.String
toString()
void
writeData(ObjectDataOutput out)
Writes object fields to output stream
-
Constructor Details
-
MerkleTreeConfig
public MerkleTreeConfig() -
MerkleTreeConfig
Clones aMerkleTreeConfig
.- Parameters:
config
- the merkle tree config to clone- Throws:
NullPointerException
- if the config is null
-
-
Method Details
-
toString
-
getDepth
public int getDepth()Returns the depth of the merkle tree. The default depth is 10. -
setDepth
Sets the depth of the merkle tree. The depth must be between 27 and 2 (exclusive).- Parameters:
depth
- the depth of the merkle tree- Returns:
- the updated config
- Throws:
InvalidConfigurationException
- if thedepth
is greater than 27 or less than 2
-
isEnabled
public boolean isEnabled()Returns if the merkle tree is enabled.- Returns:
true
if the merkle tree is enabled,false
otherwise
-
setEnabled
Enables or disables the merkle tree.- Parameters:
enabled
-true
if enabled,false
otherwise.- Returns:
- the updated config
-
getFactoryId
public int getFactoryId()Description copied from interface:IdentifiedDataSerializable
Returns DataSerializableFactory factory ID for this class.- Specified by:
getFactoryId
in interfaceIdentifiedDataSerializable
- Returns:
- factory ID
-
getClassId
public int getClassId()Description copied from interface:IdentifiedDataSerializable
Returns type identifier for this class. It should be unique per DataSerializableFactory.- Specified by:
getClassId
in interfaceIdentifiedDataSerializable
- Returns:
- type ID
-
writeData
Description copied from interface:DataSerializable
Writes object fields to output stream- Specified by:
writeData
in interfaceDataSerializable
- Parameters:
out
- output- Throws:
IOException
- if an I/O error occurs. In particular, anIOException
may be thrown if the output stream has been closed.
-
readData
Description copied from interface:DataSerializable
Reads fields from the input stream- Specified by:
readData
in interfaceDataSerializable
- Parameters:
in
- input- Throws:
IOException
- if an I/O error occurs. In particular, anIOException
may be thrown if the input stream has been closed.
-
equals
-
hashCode
public final int hashCode()
-