com.facebook.buck.core.rules.impl

Class SymlinkTree

java.lang.Object

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

com.facebook.buck.core.rules.impl.SymlinkTree

All Implemented Interfaces:

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

Direct Known Subclasses:

MappedSymlinkTree, PythonSymlinkTree

public class SymlinkTree
extends AbstractBuildRule
implements HasRuntimeDeps, SupportsInputBasedRuleKey

Creates a tree of symlinks inside of a given directory

Field Summary

Fields

Modifier and Type	Field and Description
protected String	category
protected Path	root
protected String	type

Constructor Summary

Constructors

Constructor and Description
SymlinkTree(String category, BuildTarget target, ProjectFilesystem filesystem, Path root, com.google.common.collect.ImmutableMap<Path,SourcePath> links)
SymlinkTree(String category, BuildTarget target, ProjectFilesystem filesystem, SourcePathRuleFinder finder, Path root, Symlinks links)

Method Summary

Modifier and Type	Method and Description
SortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
protected SymlinkPaths	getResolvedSymlinks(SourcePathResolverAdapter resolver)
Path	getRoot()
SourcePath	getRootSourcePath()
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
String	getType()
protected Step	getVerifyStep(SymlinkPaths links)
boolean	isCacheable() Whether this BuildRule can be cached.
static com.google.common.collect.ImmutableBiMap<SourcePath,Path>	resolveDuplicateRelativePaths(com.google.common.collect.ImmutableSortedSet<SourcePath> sourcePaths, SourcePathResolverAdapter resolver) Because of cross-cell, multiple SourcePaths can resolve to the same relative path, despite having distinct absolute paths.
protected boolean	shouldDeleteExistingSymlink(ProjectFilesystem filesystem, Path path)

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, 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.attr.SupportsInputBasedRuleKey

inputBasedRuleKeyIsEnabled, isSupported

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

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

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

getDependencies, getSourcePathOutputs

Field Detail

category

protected final String category

root

protected final Path root

type

protected final String type

Constructor Detail

SymlinkTree

public SymlinkTree(String category,
                   BuildTarget target,
                   ProjectFilesystem filesystem,
                   SourcePathRuleFinder finder,
                   Path root,
                   Symlinks links)

SymlinkTree

public SymlinkTree(String category,
                   BuildTarget target,
                   ProjectFilesystem filesystem,
                   Path root,
                   com.google.common.collect.ImmutableMap<Path,SourcePath> links)

Method Detail

resolveDuplicateRelativePaths

public static com.google.common.collect.ImmutableBiMap<SourcePath,Path> resolveDuplicateRelativePaths(com.google.common.collect.ImmutableSortedSet<SourcePath> sourcePaths,
                                                                                                      SourcePathResolverAdapter resolver)

Because of cross-cell, multiple SourcePaths can resolve to the same relative path, despite having distinct absolute paths. This presents a challenge for rules that require gathering all of the inputs in one directory.

Parameters:

sourcePaths - set of SourcePaths to process

Returns:

a map that assigns a unique relative path to each of the SourcePaths.

getType

public String getType()

Specified by:

getType in interface HasNameAndType

Overrides:

getType in class AbstractBuildRule

getBuildDeps

public SortedSet<BuildRule> getBuildDeps()

Specified by:

getBuildDeps in interface BuildRule

Returns:

the set of rules that must be built before this rule. Normally, this matches the value of the deps argument for this build rule in the build file in which it was defined.

However, there are special cases where other arguments pull in implicit dependencies (e.g., the keystore argument in android_binary). In these cases, the implicit dependencies are also included in the set returned by this method. The value of the original deps argument, as defined in the build file, must be accessed via a custom getter provided by the build rule.

getResolvedSymlinks

protected SymlinkPaths getResolvedSymlinks(SourcePathResolverAdapter resolver)

shouldDeleteExistingSymlink

protected boolean shouldDeleteExistingSymlink(ProjectFilesystem filesystem,
                                              Path path)

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getVerifyStep

protected Step getVerifyStep(SymlinkPaths links)

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

getRoot

public Path getRoot()

getRootSourcePath

public SourcePath getRootSourcePath()

getRuntimeDeps

public java.util.stream.Stream<BuildTarget> getRuntimeDeps(BuildRuleResolver buildRuleResolver)

Specified by:

getRuntimeDeps in interface HasRuntimeDeps