com.facebook.buck.parser.manifest

Class BuildPackagePathToBuildFileManifestComputation

java.lang.Object

com.facebook.buck.parser.manifest.BuildPackagePathToBuildFileManifestComputation

All Implemented Interfaces:

GraphComputation<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

public class BuildPackagePathToBuildFileManifestComputation
extends Object
implements GraphComputation<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Parses build file to BuildFileManifest structure

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>>	discoverDeps(BuildPackagePathToBuildFileManifestKey key, ComputationEnvironment env) Compute dependent keys required to compute given key, and a set of dependencies as listed by GraphComputation.discoverPreliminaryDeps(ComputeKey).
com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>>	discoverPreliminaryDeps(BuildPackagePathToBuildFileManifestKey key) Compute dependent keys required to compute given the current key.
ComputationIdentifier<BuildFileManifest>	getIdentifier()
static BuildPackagePathToBuildFileManifestComputation	of(ProjectBuildFileParser parser, Path buildFileName, Path root, boolean throwOnParseError) Create new instance of BuildPackagePathToBuildFileManifestComputation
BuildFileManifest	transform(BuildPackagePathToBuildFileManifestKey key, ComputationEnvironment env) Perform a transformation identified by key Key into a final type Result.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static BuildPackagePathToBuildFileManifestComputation of(ProjectBuildFileParser parser,
                                                                Path buildFileName,
                                                                Path root,
                                                                boolean throwOnParseError)

Create new instance of BuildPackagePathToBuildFileManifestComputation

Parameters:

parser - Parser used to parse build file. This parser should be thread-safe.

buildFileName - File name of the build file (like BUCK) expressed as a Path

root - Absolute Path to the build root, usually cell root

throwOnParseError - If true, error in parsing of a build file results in exception thrown. Otherwise an empty BuildFileManifest is created and filled with error information.

getIdentifier

public ComputationIdentifier<BuildFileManifest> getIdentifier()

Specified by:

getIdentifier in interface GraphComputation<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Returns:

the identifier of the key for this transformation. This should match ComputeKey.getIdentifier()

transform

public BuildFileManifest transform(BuildPackagePathToBuildFileManifestKey key,
                                   ComputationEnvironment env)
                            throws Exception

Description copied from interface: GraphComputation

Perform a transformation identified by key Key into a final type Result. This transformation should be performed synchronously.

Specified by:

transform in interface GraphComputation<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Parameters:

key - The Key of the requested result

env - The execution environment containing results of keys from GraphComputation.discoverDeps(ComputeKey, ComputationEnvironment) and GraphComputation.discoverPreliminaryDeps(ComputeKey)

Returns:

The result of the transformation

Throws:

Exception

discoverDeps

public com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>> discoverDeps(BuildPackagePathToBuildFileManifestKey key,
                                                                                                          ComputationEnvironment env)

Description copied from interface: GraphComputation

Compute dependent keys required to compute given key, and a set of dependencies as listed by GraphComputation.discoverPreliminaryDeps(ComputeKey). The results of those computations will be available in GraphComputation.transform(ComputeKey, ComputationEnvironment) as a part of ComputationEnvironment

Specified by:

discoverDeps in interface GraphComputation<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Parameters:

key - the current key to transform

env - The execution environment containing results of keys from GraphComputation.discoverPreliminaryDeps(ComputeKey)

Returns:

a set of keys that the transformation of the current key depends on

discoverPreliminaryDeps

public com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>> discoverPreliminaryDeps(BuildPackagePathToBuildFileManifestKey key)

Description copied from interface: GraphComputation

Compute dependent keys required to compute given the current key. The results of those computations will be available in GraphComputation.discoverDeps(ComputeKey, ComputationEnvironment) as a part of ComputationEnvironment, and GraphComputation.transform(ComputeKey, ComputationEnvironment)

Specified by:

discoverPreliminaryDeps in interface GraphComputation<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Parameters:

key - the current key to transform

Returns:

a set of keys that the GraphComputation.discoverDeps(ComputeKey, ComputationEnvironment) and GraphComputation.transform(ComputeKey, ComputationEnvironment) of the current key depends on