com.facebook.buck.core.build.engine.buildinfo

Class BuildInfoRecorder

java.lang.Object

com.facebook.buck.core.build.engine.buildinfo.BuildInfoRecorder

public class BuildInfoRecorder
extends Object

Utility for recording the paths to the output files generated by a build rule, as well as any metadata about those output files. This data will be packaged up into an artifact that will be stored in the cache. The metadata will also be written to disk so it can be read on a subsequent build by an OnDiskBuildInfo.

Constructor Summary

Constructors

Constructor and Description
BuildInfoRecorder(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildInfoStore buildInfoStore, Clock clock, BuildId buildId, com.google.common.collect.ImmutableMap<String,String> environment)

Method Summary

Modifier and Type	Method and Description
BuildInfoRecorder	addBuildMetadata(String key, String value) Used by the build engine to record metadata describing the build (e.g.
void	addMetadata(String key, com.google.common.collect.ImmutableList<String> value)
void	addMetadata(String key, String value) This key/value pair is stored in memory until writeMetadataToDisk(boolean) is invoked.
void	assertOnlyHasKeys(String... keys)
Optional<String>	getBuildMetadataFor(String key)
com.google.common.hash.HashCode	getOutputHash(FileHashLoader fileHashLoader)
com.google.common.collect.ImmutableSortedSet<Path>	getRecordedPaths()
void	recordArtifact(Path pathToArtifact)
void	updateBuildMetadata()
void	writeMetadataToDisk(boolean clearExistingMetadata) Writes the metadata currently stored in memory to the directory returned by BuildInfo.getPathToArtifactMetadataDirectory(BuildTarget, ProjectFilesystem).

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildInfoRecorder

public BuildInfoRecorder(BuildTarget buildTarget,
                         ProjectFilesystem projectFilesystem,
                         BuildInfoStore buildInfoStore,
                         Clock clock,
                         BuildId buildId,
                         com.google.common.collect.ImmutableMap<String,String> environment)

Method Detail

writeMetadataToDisk

public void writeMetadataToDisk(boolean clearExistingMetadata)
                         throws IOException

Writes the metadata currently stored in memory to the directory returned by BuildInfo.getPathToArtifactMetadataDirectory(BuildTarget, ProjectFilesystem).

Throws:

IOException

updateBuildMetadata

public void updateBuildMetadata()
                         throws IOException

Throws:

IOException

addBuildMetadata

public BuildInfoRecorder addBuildMetadata(String key,
                                          String value)

Used by the build engine to record metadata describing the build (e.g. rule key, build UUID).

addMetadata

public void addMetadata(String key,
                        String value)

This key/value pair is stored in memory until writeMetadataToDisk(boolean) is invoked.

addMetadata

public void addMetadata(String key,
                        com.google.common.collect.ImmutableList<String> value)

getRecordedPaths

public com.google.common.collect.ImmutableSortedSet<Path> getRecordedPaths()

getOutputHash

public com.google.common.hash.HashCode getOutputHash(FileHashLoader fileHashLoader)
                                              throws IOException

Throws:

IOException

recordArtifact

public void recordArtifact(Path pathToArtifact)

Parameters:

pathToArtifact - Relative path to the project root.

getBuildMetadataFor

public Optional<String> getBuildMetadataFor(String key)

assertOnlyHasKeys

public void assertOnlyHasKeys(String... keys)