com.facebook.buck.parser.targetnode

Class BuildPackagePathToUnconfiguredTargetNodePackageComputation

java.lang.Object

com.facebook.buck.parser.targetnode.BuildPackagePathToUnconfiguredTargetNodePackageComputation

All Implemented Interfaces:

GraphComputation<BuildPackagePathToUnconfiguredTargetNodePackageKey,UnconfiguredTargetNodeWithDepsPackage>

public class BuildPackagePathToUnconfiguredTargetNodePackageComputation
extends Object
implements GraphComputation<BuildPackagePathToUnconfiguredTargetNodePackageKey,UnconfiguredTargetNodeWithDepsPackage>

Transforms all targets from results of parsing a single build file to UnconfiguredTargetNodeWithDepsPackage

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>>	discoverDeps(BuildPackagePathToUnconfiguredTargetNodePackageKey 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(BuildPackagePathToUnconfiguredTargetNodePackageKey key) Compute dependent keys required to compute given the current key.
ComputationIdentifier<UnconfiguredTargetNodeWithDepsPackage>	getIdentifier()
static BuildPackagePathToUnconfiguredTargetNodePackageComputation	of(UnconfiguredTargetNodeToTargetNodeFactory unconfiguredTargetNodeToTargetNodeFactory, Cells cells, Cell cell, boolean throwOnValidationError) Create new instance of BuildPackagePathToUnconfiguredTargetNodePackageComputation
UnconfiguredTargetNodeWithDepsPackage	transform(BuildPackagePathToUnconfiguredTargetNodePackageKey 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 BuildPackagePathToUnconfiguredTargetNodePackageComputation of(UnconfiguredTargetNodeToTargetNodeFactory unconfiguredTargetNodeToTargetNodeFactory,
                                                                            Cells cells,
                                                                            Cell cell,
                                                                            boolean throwOnValidationError)

Create new instance of BuildPackagePathToUnconfiguredTargetNodePackageComputation

Parameters:

unconfiguredTargetNodeToTargetNodeFactory - A factory that does translation from raw target node to configured target node. We use configured target node to infer target dependencies, but in the future we won't need that

cell - Cell object that owns the package being created

throwOnValidationError - If true, computation throws aborting the workflow. Otherwise a package with no targets and no deps but errors is created

getIdentifier

public ComputationIdentifier<UnconfiguredTargetNodeWithDepsPackage> getIdentifier()

Specified by:

getIdentifier in interface GraphComputation<BuildPackagePathToUnconfiguredTargetNodePackageKey,UnconfiguredTargetNodeWithDepsPackage>

Returns:

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

transform

public UnconfiguredTargetNodeWithDepsPackage transform(BuildPackagePathToUnconfiguredTargetNodePackageKey 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<BuildPackagePathToUnconfiguredTargetNodePackageKey,UnconfiguredTargetNodeWithDepsPackage>

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(BuildPackagePathToUnconfiguredTargetNodePackageKey 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<BuildPackagePathToUnconfiguredTargetNodePackageKey,UnconfiguredTargetNodeWithDepsPackage>

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(BuildPackagePathToUnconfiguredTargetNodePackageKey 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<BuildPackagePathToUnconfiguredTargetNodePackageKey,UnconfiguredTargetNodeWithDepsPackage>

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