com.facebook.buck.remoteexecution.util

Class MerkleTreeNodeCache

java.lang.Object

com.facebook.buck.remoteexecution.util.MerkleTreeNodeCache

public class MerkleTreeNodeCache
extends Object

MerkleTreeNodeCache is used to create and merge merkle trees for action inputs. The nodes are interned.

It also provides methods to get the Protocol encoded merkle tree data structures (these values are cached once computed for a node).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MerkleTreeNodeCache.MerkleTreeNode Represents a node in the merkle tree of files and symlinks.
static class	MerkleTreeNodeCache.NodeData NodeData is the Protocol encoded data for a node.

Constructor Summary

Constructors

Constructor and Description
MerkleTreeNodeCache(Protocol protocol)

Method Summary

Modifier and Type	Method and Description
MerkleTreeNodeCache.MerkleTreeNode	createNode(Map<Path,Protocol.FileNode> files, Map<Path,Protocol.SymlinkNode> symlinks, Map<Path,Protocol.DirectoryNode> emptyDirectories) Creates the full tree of nodes for the provided files, symlinks and empty directories and returns the root node.
void	forAllData(MerkleTreeNodeCache.MerkleTreeNode rootNode, java.util.function.Consumer<MerkleTreeNodeCache.NodeData> dataConsumer) Iterate over all the encoded data for the tree rooted at the provided node.
MerkleTreeNodeCache.NodeData	getData(MerkleTreeNodeCache.MerkleTreeNode node) Gets the Protocol encoded data for the provided tree.
MerkleTreeNodeCache.MerkleTreeNode	mergeNodes(Collection<MerkleTreeNodeCache.MerkleTreeNode> nodes) This will merge multiple merkle trees into one.

Methods inherited from class java.lang.Object

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

Constructor Detail

MerkleTreeNodeCache

public MerkleTreeNodeCache(Protocol protocol)

Method Detail

createNode

public MerkleTreeNodeCache.MerkleTreeNode createNode(Map<Path,Protocol.FileNode> files,
                                                     Map<Path,Protocol.SymlinkNode> symlinks,
                                                     Map<Path,Protocol.DirectoryNode> emptyDirectories)

Creates the full tree of nodes for the provided files, symlinks and empty directories and returns the root node.

mergeNodes

public MerkleTreeNodeCache.MerkleTreeNode mergeNodes(Collection<MerkleTreeNodeCache.MerkleTreeNode> nodes)

This will merge multiple merkle trees into one. It's quite efficient for non/slightly-overlapping trees.

forAllData

public void forAllData(MerkleTreeNodeCache.MerkleTreeNode rootNode,
                       java.util.function.Consumer<MerkleTreeNodeCache.NodeData> dataConsumer)

Iterate over all the encoded data for the tree rooted at the provided node. This is useful for collecting all the data that will be needed to reconstruct the merkle tree.

getData

public MerkleTreeNodeCache.NodeData getData(MerkleTreeNodeCache.MerkleTreeNode node)

Gets the Protocol encoded data for the provided tree.