com.facebook.buck.core.parser

Class BuildTargetPatternToBuildPackagePathComputation

java.lang.Object

com.facebook.buck.core.parser.BuildTargetPatternToBuildPackagePathComputation

All Implemented Interfaces:

GraphComputation<BuildTargetPatternToBuildPackagePathKey,BuildPackagePaths>

public class BuildTargetPatternToBuildPackagePathComputation
extends Object
implements GraphComputation<BuildTargetPatternToBuildPackagePathKey,BuildPackagePaths>

Discover paths for packages which contain targets that match specification (build target pattern)

This computation depends on FileTreeKey (FileTreeComputation) and DirectoryListKey (DirectoryListComputation).

See WatchmanBuildPackageComputation for an equivalent computation which uses Watchman.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>>	discoverDeps(BuildTargetPatternToBuildPackagePathKey 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(BuildTargetPatternToBuildPackagePathKey key) Compute dependent keys required to compute given the current key.
ComputationIdentifier<BuildPackagePaths>	getIdentifier()
static BuildTargetPatternToBuildPackagePathComputation	of(String buildFileName, ProjectFilesystemView projectFilesystemView) Create new instance of BuildTargetPatternToBuildPackagePathComputation
BuildPackagePaths	transform(BuildTargetPatternToBuildPackagePathKey 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 BuildTargetPatternToBuildPackagePathComputation of(String buildFileName,
                                                                 ProjectFilesystemView projectFilesystemView)

Create new instance of BuildTargetPatternToBuildPackagePathComputation

Parameters:

buildFileName - Name of the build file to determine a package root folder, for example 'BUCK'

getIdentifier

public ComputationIdentifier<BuildPackagePaths> getIdentifier()

Specified by:

getIdentifier in interface GraphComputation<BuildTargetPatternToBuildPackagePathKey,BuildPackagePaths>

Returns:

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

transform

public BuildPackagePaths transform(BuildTargetPatternToBuildPackagePathKey key,
                                   ComputationEnvironment env)

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<BuildTargetPatternToBuildPackagePathKey,BuildPackagePaths>

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

discoverDeps

public com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>> discoverDeps(BuildTargetPatternToBuildPackagePathKey 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<BuildTargetPatternToBuildPackagePathKey,BuildPackagePaths>

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(BuildTargetPatternToBuildPackagePathKey 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<BuildTargetPatternToBuildPackagePathKey,BuildPackagePaths>

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