com.facebook.buck.cxx

Class Archive

java.lang.Object

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

com.facebook.buck.rules.modern.ModernBuildRule<com.facebook.buck.cxx.Archive.Impl>

com.facebook.buck.cxx.Archive

All Implemented Interfaces:

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

public class Archive
extends ModernBuildRule<com.facebook.buck.cxx.Archive.Impl>

A BuildRule which builds an "ar" archive from input files represented as SourcePath.

Method Summary

Modifier and Type	Method and Description
static Archive	from(BuildTarget target, ProjectFilesystem projectFilesystem, BuildRuleResolver resolver, CxxPlatform platform, String outputFileName, com.google.common.collect.ImmutableList<SourcePath> inputs)
static Archive	from(BuildTarget target, ProjectFilesystem projectFilesystem, BuildRuleResolver resolver, CxxPlatform platform, String outputFileName, com.google.common.collect.ImmutableList<SourcePath> inputs, ArchiveContents contents, boolean cacheable)
SourcePath	getSourcePathToOutput()
boolean	isCacheable() Whether this BuildRule can be cached.
Arg	toArg()

Methods inherited from class com.facebook.buck.rules.modern.ModernBuildRule

compareTo, getBuildable, getBuildCellPathFactory, getBuildDeps, getBuildSteps, getOutputPathResolver, getSetupStepsForBuildable, getSourcePath, getSourcePaths, injectFieldsIfNecessary, inputBasedRuleKeyIsEnabled, recordOutputs, recordOutputs, recordOutputs, stepsForBuildable, stepsForBuildable, updateBuildRuleResolver

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

isSupported

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

getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

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

getType

Method Detail

from

public static Archive from(BuildTarget target,
                           ProjectFilesystem projectFilesystem,
                           BuildRuleResolver resolver,
                           CxxPlatform platform,
                           String outputFileName,
                           com.google.common.collect.ImmutableList<SourcePath> inputs,
                           ArchiveContents contents,
                           boolean cacheable)

Returns:

the Archive created from the given parameters.

from

public static Archive from(BuildTarget target,
                           ProjectFilesystem projectFilesystem,
                           BuildRuleResolver resolver,
                           CxxPlatform platform,
                           String outputFileName,
                           com.google.common.collect.ImmutableList<SourcePath> inputs)

Returns:

the Archive created from the given parameters.

toArg

public Arg toArg()

Returns:

the Arg to use when using this archive. When thin archives are used, this will ensure that the inputs are also propagated as build time deps to whatever rule uses this archive.

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

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<com.facebook.buck.cxx.Archive.Impl>