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

Class DefaultOnDiskBuildInfo

java.lang.Object

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

All Implemented Interfaces:

OnDiskBuildInfo

public class DefaultOnDiskBuildInfo
extends Object
implements OnDiskBuildInfo

Utility for reading the metadata associated with a build rule's output. This is metadata that would have been written by a BuildInfoRecorder when the rule was built initially.

Such metadata is stored as key/value pairs.

Constructor Summary

Constructors

Constructor and Description
DefaultOnDiskBuildInfo(BuildTarget target, ProjectFilesystem projectFilesystem, BuildInfoStore buildInfoStore)

Method Summary

Modifier and Type	Method and Description
void	calculateOutputSizeAndWriteMetadata(FileHashLoader fileHashLoader, com.google.common.collect.ImmutableSortedSet<Path> recordedPaths, com.google.common.base.Predicate<Long> shouldWriteOutputHashes)
void	deleteExistingMetadata() Deletes both "artifact" and "build" metadata.
Optional<String>	getBuildValue(String key)
Optional<com.google.common.collect.ImmutableMap<String,String>>	getMap(String key)
com.google.common.collect.ImmutableSortedMap<String,String>	getMetadataForArtifact() Returns the "build" metadata that is stored with a cache artifact ("artifact" metadata is stored within the artifact itself).
com.google.common.collect.ImmutableSortedSet<Path>	getOutputPaths()
com.google.common.collect.ImmutableSortedSet<Path>	getPathsForArtifact() Returns the recorded output paths of the rule for creating a cache artifact.
Optional<RuleKey>	getRuleKey(String key) Returns the RuleKey for the rule whose output is currently stored on disk.
Either<String,Exception>	getValue(String key)
Optional<com.google.common.collect.ImmutableList<String>>	getValues(String key)
com.google.common.collect.ImmutableList<String>	getValuesOrThrow(String key) Tries to read the "artifact" values and if it fails it logs the attributes of the file it tried to read.
void	validateArtifact(Set<Path> extractedFiles)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOnDiskBuildInfo

public DefaultOnDiskBuildInfo(BuildTarget target,
                              ProjectFilesystem projectFilesystem,
                              BuildInfoStore buildInfoStore)

Method Detail

getValue

public Either<String,Exception> getValue(String key)

Specified by:

getValue in interface OnDiskBuildInfo

Returns:

the rule "artifact" metadata value associated with the specified key, if it exists.

getBuildValue

public Optional<String> getBuildValue(String key)

Specified by:

getBuildValue in interface OnDiskBuildInfo

Returns:

the build engine metadata value associated with the specified key, if it exists.

getValues

public Optional<com.google.common.collect.ImmutableList<String>> getValues(String key)

Specified by:

getValues in interface OnDiskBuildInfo

Returns:

the sequence of "artifact" values associated with the specified key, if it exists.

getValuesOrThrow

public com.google.common.collect.ImmutableList<String> getValuesOrThrow(String key)
                                                                 throws IOException

Description copied from interface: OnDiskBuildInfo

Tries to read the "artifact" values and if it fails it logs the attributes of the file it tried to read.

Specified by:

getValuesOrThrow in interface OnDiskBuildInfo

Throws:

IOException

getMap

public Optional<com.google.common.collect.ImmutableMap<String,String>> getMap(String key)

Specified by:

getMap in interface OnDiskBuildInfo

Returns:

the map of strings associated with the specified key in the "build" metadata, if it exists.

getOutputPaths

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

Specified by:

getOutputPaths in interface OnDiskBuildInfo

getPathsForArtifact

public com.google.common.collect.ImmutableSortedSet<Path> getPathsForArtifact()
                                                                       throws IOException

Description copied from interface: OnDiskBuildInfo

Returns the recorded output paths of the rule for creating a cache artifact.

Specified by:

getPathsForArtifact in interface OnDiskBuildInfo

Throws:

IOException

getMetadataForArtifact

public com.google.common.collect.ImmutableSortedMap<String,String> getMetadataForArtifact()
                                                                                   throws IOException

Description copied from interface: OnDiskBuildInfo

Returns the "build" metadata that is stored with a cache artifact ("artifact" metadata is stored within the artifact itself).

Specified by:

getMetadataForArtifact in interface OnDiskBuildInfo

Throws:

IOException

getRuleKey

public Optional<RuleKey> getRuleKey(String key)

Description copied from interface: OnDiskBuildInfo

Returns the RuleKey for the rule whose output is currently stored on disk.

This value would have been written the last time the rule was built successfully.

Specified by:

getRuleKey in interface OnDiskBuildInfo

deleteExistingMetadata

public void deleteExistingMetadata()
                            throws IOException

Description copied from interface: OnDiskBuildInfo

Deletes both "artifact" and "build" metadata.

Specified by:

deleteExistingMetadata in interface OnDiskBuildInfo

Throws:

IOException

calculateOutputSizeAndWriteMetadata

public void calculateOutputSizeAndWriteMetadata(FileHashLoader fileHashLoader,
                                                com.google.common.collect.ImmutableSortedSet<Path> recordedPaths,
                                                com.google.common.base.Predicate<Long> shouldWriteOutputHashes)
                                         throws IOException

Specified by:

calculateOutputSizeAndWriteMetadata in interface OnDiskBuildInfo

Throws:

IOException

validateArtifact

public void validateArtifact(Set<Path> extractedFiles)
                      throws IOException

Specified by:

validateArtifact in interface OnDiskBuildInfo

Throws:

IOException