com.facebook.buck.core.model.impl

Class BuildPaths

java.lang.Object

com.facebook.buck.core.model.impl.BuildPaths

public class BuildPaths
extends Object

Utility class that generates the build output paths for BuildTargets in a systematic manner.

Method Summary

Modifier and Type	Method and Description
static Path	getAnnotationDir(ProjectFilesystem filesystem, BuildTarget target) Return a path to a file in the buck-out/annotation/ directory, formatted with the target short name.
static ForwardRelativePath	getBaseDir(ProjectFilesystem filesystem, BuildTarget target) Return a relative path to a file taking into account the target's package path and formatting with the short name.
static Path	getGenDir(ProjectFilesystem filesystem, BuildTarget target) Return a relative path to a file in the buck-out/gen/ directory, formatted with the target short name.
static Path	getScratchDir(ProjectFilesystem filesystem, BuildTarget target) Return a path to a file in the buck-out/bin/ directory, formatted with the target short name.
static Optional<Path>	removeHashFrom(Path path, BuildTarget target) Removes the hash from the buck-out path.

Methods inherited from class java.lang.Object

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

Method Detail

getScratchDir

public static Path getScratchDir(ProjectFilesystem filesystem,
                                 BuildTarget target)

Return a path to a file in the buck-out/bin/ directory, formatted with the target short name.

Parameters:

target - The BuildTarget to scope this path to.

Returns:

A Path under buck-out/bin, scoped to the base path of target.

getAnnotationDir

public static Path getAnnotationDir(ProjectFilesystem filesystem,
                                    BuildTarget target)

Return a path to a file in the buck-out/annotation/ directory, formatted with the target short name.

Parameters:

target - The BuildTarget to scope this path to.

Returns:

A Path under buck-out/annotation, scoped to the base path of target.

getGenDir

public static Path getGenDir(ProjectFilesystem filesystem,
                             BuildTarget target)

Return a relative path to a file in the buck-out/gen/ directory, formatted with the target short name.

Parameters:

target - The BuildTarget to scope this path to.

Returns:

A Path under buck-out/gen, scoped to the base path of target.

getBaseDir

public static ForwardRelativePath getBaseDir(ProjectFilesystem filesystem,
                                             BuildTarget target)

Return a relative path to a file taking into account the target's package path and formatting with the short name.

This is a portion of the path returned by, e.g., getGenDir(ProjectFilesystem, BuildTarget)

Parameters:

target - The BuildTarget to scope this path to.

Returns:

A Path scoped to the base path to target.

removeHashFrom

public static Optional<Path> removeHashFrom(Path path,
                                            BuildTarget target)

Removes the hash from the buck-out path. Used temporarily to create links.

Parameters:

path - Hashed buck-out path

target - Build target that generated path

Returns:

A path without the hash directory or Optional.empty() if the hash was not found.