com.facebook.buck.core.files

Class DirectoryListComputation

java.lang.Object

com.facebook.buck.core.files.DirectoryListComputation

All Implemented Interfaces:

GraphComputation<DirectoryListKey,DirectoryList>

public class DirectoryListComputation
extends Object
implements GraphComputation<DirectoryListKey,DirectoryList>

Produce a list of files and directories in provided folder

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<? extends ComputeKey<? extends ComputeResult>>	discoverDeps(DirectoryListKey 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(DirectoryListKey key) Compute dependent keys required to compute given the current key.
ComputationIdentifier<DirectoryList>	getIdentifier()
static DirectoryListComputation	of(ProjectFilesystemView fileSystemView)
DirectoryList	transform(DirectoryListKey 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 DirectoryListComputation of(ProjectFilesystemView fileSystemView)

getIdentifier

public ComputationIdentifier<DirectoryList> getIdentifier()

Specified by:

getIdentifier in interface GraphComputation<DirectoryListKey,DirectoryList>

Returns:

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

transform

public DirectoryList transform(DirectoryListKey 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<DirectoryListKey,DirectoryList>

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(DirectoryListKey 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<DirectoryListKey,DirectoryList>

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(DirectoryListKey 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<DirectoryListKey,DirectoryList>

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