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

Interface OnDiskBuildInfo

All Known Implementing Classes:

DefaultOnDiskBuildInfo

public interface OnDiskBuildInfo

Provides access to the on-disk rule metadata (both "artifact" and "build").

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.ImmutableMap<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)

Method Detail

getValue

Either<String,Exception> getValue(String key)

Returns:

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

getBuildValue

Optional<String> getBuildValue(String key)

Returns:

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

getValues

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

Returns:

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

getValuesOrThrow

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

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

Throws:

IOException

getMap

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

Returns:

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

getRuleKey

Optional<RuleKey> getRuleKey(String key)

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.

getPathsForArtifact

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

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

Throws:

IOException

getMetadataForArtifact

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

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

Throws:

IOException

deleteExistingMetadata

void deleteExistingMetadata()
                     throws IOException

Deletes both "artifact" and "build" metadata.

Throws:

IOException

calculateOutputSizeAndWriteMetadata

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

Throws:

IOException

validateArtifact

void validateArtifact(Set<Path> extractedFiles)
               throws IOException

Throws:

IOException

getOutputPaths

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