com.facebook.buck.step.fs

Class SymlinkTreeMergeStep

java.lang.Object

com.facebook.buck.step.fs.SymlinkTreeMergeStep

All Implemented Interfaces:

Step

public class SymlinkTreeMergeStep
extends Object
implements Step

A step to merge the contents of provided directories into a symlink tree

Constructor Summary

Constructors

Constructor and Description
SymlinkTreeMergeStep(String category, ProjectFilesystem filesystem, Path root, SymlinkPaths links, java.util.function.BiFunction<ProjectFilesystem,Path,Boolean> deleteExistingLinkPredicate) Creates an instance of SymlinkTreeMergeStep

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
StepExecutionResult	execute(ExecutionContext context)
String	getDescription(ExecutionContext context)
String	getShortName()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

SymlinkTreeMergeStep

public SymlinkTreeMergeStep(String category,
                            ProjectFilesystem filesystem,
                            Path root,
                            SymlinkPaths links,
                            java.util.function.BiFunction<ProjectFilesystem,Path,Boolean> deleteExistingLinkPredicate)

Creates an instance of SymlinkTreeMergeStep

Parameters:

category - The type of link tree that will be used. This is used in the name

filesystem - The filesystem that the root resides on

root - The root of the link tree

links - A map of relative paths within the link tree into which files from the value will be recursively linked. e.g. if a file at /tmp/foo/bar should be linked as /tmp/symlink-root/subdir/bar, the map should contain {Paths.get("subdir"),

deleteExistingLinkPredicate - A predicate that, given an existing filesystem and target of an existing symlink, can return 'true' if the original link should be deleted. This is used in the case that there are conflicting files when merging links into root. A common example is dummy __init__.py files placed by PythonInPlaceBinary which may be deleted safely in the destination directory if one of the other directories being merged has a file with some substance.

Method Detail

getDescription

public String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step

getShortName

public String getShortName()

Specified by:

getShortName in interface Step

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException

Specified by:

execute in interface Step

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object