com.facebook.buck.features.ocaml

Class OcamlBuild

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.features.ocaml.OcamlBuild

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, BuildRule, HasNameAndType, Comparable<BuildRule>

public class OcamlBuild
extends AbstractBuildRuleWithDeclaredAndExtraDeps

A build rule which preprocesses, compiles, and assembles an OCaml source.

Constructor Summary

Constructors

Constructor and Description
OcamlBuild(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, com.facebook.buck.features.ocaml.OcamlBuildContext ocamlContext, Compiler cCompiler, Linker cxxLinker, boolean bytecodeOnly)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
com.facebook.buck.features.ocaml.OcamlBuildContext	getOcamlContext()
SourcePath	getSourcePathToOutput()
boolean	isCacheable() Whether this BuildRule can be cached.

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, toString, updateBuildRuleResolver

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

OcamlBuild

public OcamlBuild(BuildTarget buildTarget,
                  ProjectFilesystem projectFilesystem,
                  BuildRuleParams params,
                  com.facebook.buck.features.ocaml.OcamlBuildContext ocamlContext,
                  Compiler cCompiler,
                  Linker cxxLinker,
                  boolean bytecodeOnly)

Method Detail

getBuildSteps

public com.google.common.collect.ImmutableList<Step> getBuildSteps(BuildContext context,
                                                                   BuildableContext buildableContext)

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

isCacheable

public boolean isCacheable()

Description copied from interface: BuildRule

Whether this BuildRule can be cached.

Uncached build rules are never written out to cache, never read from cache, and does not count in cache statistics. This rule is useful for artifacts which cannot be easily normalized.

Uncached rules are not always rebuilt, however, as long as the existing on-disk representation is up to date. This means that these rules can take advantage of SupportsInputBasedRuleKey to prevent rebuilding.

Specified by:

isCacheable in interface BuildEngineAction

Specified by:

isCacheable in interface BuildRule

Overrides:

isCacheable in class AbstractBuildRule

getOcamlContext

public com.facebook.buck.features.ocaml.OcamlBuildContext getOcamlContext()