com.facebook.buck.core.graph.transformation

Interface GraphTransformationEngine

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultGraphTransformationEngine

public interface GraphTransformationEngine
extends AutoCloseable

Transformation engine that transforms supplied ComputeKey into ComputeResult via GraphComputation. This engine is able to asynchronously run graph based computation, reusing results when possible. Note that the computation graph must be an acyclic graph.

This engine is able to deal with dependencies in the computation graph by having GraphComputation request dependent results of other transformations through GraphComputation.discoverPreliminaryDeps(ComputeKey) and GraphComputation.discoverDeps(ComputeKey, ComputationEnvironment)

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the engine and rejects any future computations
<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> Future<ResultType>	compute(KeyType key) Asynchronously computes the result for the given key
<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> com.google.common.collect.ImmutableMap<KeyType,Future<ResultType>>	computeAll(Set<KeyType> keys) Asynchronously computes the result for multiple keys
<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> com.google.common.collect.ImmutableMap<KeyType,ResultType>	computeAllUnchecked(Set<KeyType> keys) Synchronously computes the result for multiple keys
<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> ResultType	computeUnchecked(KeyType key) Synchronously computes the given key

Method Detail

close

void close()

Shuts down the engine and rejects any future computations

Specified by:

close in interface AutoCloseable

compute

<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> Future<ResultType> compute(KeyType key)

Asynchronously computes the result for the given key

Parameters:

key - the specific Key on the graph to compute

Returns:

future of the result of applying the transformer on the graph with the given key

computeUnchecked

<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> ResultType computeUnchecked(KeyType key)

Synchronously computes the given key

Parameters:

key - the specific Key on the graph to compute

Returns:

the result of applying the transformer on the graph with the given key

computeAll

<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> com.google.common.collect.ImmutableMap<KeyType,Future<ResultType>> computeAll(Set<KeyType> keys)

Asynchronously computes the result for multiple keys

Parameters:

keys - iterable of keys to compute on the graph

Returns:

a map of futures of the result for each of the keys supplied

computeAllUnchecked

<KeyType extends ComputeKey<ResultType>,ResultType extends ComputeResult> com.google.common.collect.ImmutableMap<KeyType,ResultType> computeAllUnchecked(Set<KeyType> keys)

Synchronously computes the result for multiple keys

Parameters:

keys - iterable of the keys to compute on the graph

Returns:

a map of the results for each of the keys supplied