com.facebook.buck.core.build.engine

Interface BuildEngine

All Known Implementing Classes:

CachingBuildEngine

public interface BuildEngine

A build engine is responsible for building a given build rule, which includes all its transitive dependencies.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BuildEngine.BuildEngineResult

Method Summary

Modifier and Type	Method and Description
BuildEngine.BuildEngineResult	build(BuildEngineBuildContext buildContext, ExecutionContext executionContext, BuildRule rule) Build the given build rule and return a future to the build rule success.
BuildResult	getBuildRuleResult(BuildTarget buildTarget) Returns the build result of the build rule associated with the given build target.
int	getNumRulesToBuild(Iterable<BuildRule> rule) Calculate the total number of transitive build rules processed from the given roots.
boolean	isRuleBuilt(BuildTarget buildTarget) Returns whether the build rule associated with the build target has been successfully built.
void	terminateBuildWithFailure(Throwable failure) Marks build as failed with the given Throwable.

Method Detail

getNumRulesToBuild

int getNumRulesToBuild(Iterable<BuildRule> rule)

Calculate the total number of transitive build rules processed from the given roots.

build

BuildEngine.BuildEngineResult build(BuildEngineBuildContext buildContext,
                                    ExecutionContext executionContext,
                                    BuildRule rule)

Build the given build rule and return a future to the build rule success.

getBuildRuleResult

@Nullable
BuildResult getBuildRuleResult(BuildTarget buildTarget)
                                  throws ExecutionException,
                                         InterruptedException

Returns the build result of the build rule associated with the given build target. Returns null if the build rule has not yet been built.

Throws:

ExecutionException

InterruptedException

isRuleBuilt

boolean isRuleBuilt(BuildTarget buildTarget)
             throws InterruptedException

Returns whether the build rule associated with the build target has been successfully built.

Throws:

InterruptedException

terminateBuildWithFailure

void terminateBuildWithFailure(Throwable failure)

Marks build as failed with the given Throwable. If keepGoing == false, any pending steps will be terminated before starting.

Parameters:

failure -