com.facebook.buck.io.filesystem

Class BuckPaths

java.lang.Object

com.facebook.buck.io.filesystem.BuckPaths

public abstract class BuckPaths
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BUCK_OUT_INCLUDE_TARGET_CONFIG_HASH Default value for shouldIncludeTargetConfigHash() when it is not specified by user.

Constructor Summary

Constructors

Constructor and Description
BuckPaths()

Method Summary

Modifier and Type	Method and Description
protected void	checkBuckOut()
static BuckPaths	createDefaultBuckPaths(CanonicalCellName cellName, Path rootPath, boolean buckOutIncludeTargetConfigHash)
Path	getAnnotationDir()
abstract Path	getBuckOut() The relative path to the directory where Buck will generate its files.
static boolean	getBuckOutIncludeTargetConfigHashFromRootCellConfig(Config config) Is hashed buck-out enabled? Must be queried using root cell buckconfig.
Path	getCacheDir()
abstract CanonicalCellName	getCellName()
abstract Path	getConfiguredBuckOut() The relative path to the directory where Buck will generate its files.
Path	getCurrentVersionFile() The version the buck output directory was created for
Path	getEmbeddedCellsBuckOutBaseDir()
Path	getGenDir()
Path	getJournalDir()
Path	getLastOutputDir()
Path	getLogDir()
Path	getOfflineLogDir()
Path	getProjectRootDir()
Path	getRemoteSandboxDir()
Path	getResDir()
Path	getScratchDir()
Path	getSymlinkPathForDir(Path unconfiguredDirInBuckOut)
Path	getTmpDir()
Path	getTraceDir()
Path	getTrashDir()
Path	getXcodeDir()
static BuckPaths	of(CanonicalCellName cellName, Path buckOut, Path configuredBuckOut, boolean shouldIncludeTargetConfigHash)
abstract boolean	shouldIncludeTargetConfigHash() Whether to include the target configuration hash on buck-out.
BuckPaths	withBuckOut(Path buckOut)
BuckPaths	withConfiguredBuckOut(Path configuredBuckOut)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUCK_OUT_INCLUDE_TARGET_CONFIG_HASH

public static final boolean DEFAULT_BUCK_OUT_INCLUDE_TARGET_CONFIG_HASH

Default value for shouldIncludeTargetConfigHash() when it is not specified by user.

See Also:

Constant Field Values

Constructor Detail

BuckPaths

public BuckPaths()

Method Detail

createDefaultBuckPaths

public static BuckPaths createDefaultBuckPaths(CanonicalCellName cellName,
                                               Path rootPath,
                                               boolean buckOutIncludeTargetConfigHash)

getBuckOutIncludeTargetConfigHashFromRootCellConfig

public static boolean getBuckOutIncludeTargetConfigHashFromRootCellConfig(Config config)

Is hashed buck-out enabled? Must be queried using root cell buckconfig.

getCellName

public abstract CanonicalCellName getCellName()

getBuckOut

public abstract Path getBuckOut()

The relative path to the directory where Buck will generate its files.

checkBuckOut

@Value.Check
protected void checkBuckOut()

getConfiguredBuckOut

public abstract Path getConfiguredBuckOut()

The relative path to the directory where Buck will generate its files. This is used when configuring the output directory to some used-defined value and is a stop-gap until we can support configuring all output paths. However, for now, only certain paths below will use this path.

shouldIncludeTargetConfigHash

public abstract boolean shouldIncludeTargetConfigHash()

Whether to include the target configuration hash on buck-out.

getCurrentVersionFile

@Value.Derived
public Path getCurrentVersionFile()

The version the buck output directory was created for

getGenDir

@Value.Derived
public Path getGenDir()

getResDir

@Value.Derived
public Path getResDir()

getScratchDir

@Value.Derived
public Path getScratchDir()

getAnnotationDir

@Value.Derived
public Path getAnnotationDir()

getLogDir

@Value.Derived
public Path getLogDir()

getJournalDir

@Value.Derived
public Path getJournalDir()

getTraceDir

@Value.Derived
public Path getTraceDir()

getCacheDir

@Value.Derived
public Path getCacheDir()

getTmpDir

@Value.Derived
public Path getTmpDir()

getXcodeDir

@Value.Derived
public Path getXcodeDir()

getTrashDir

@Value.Derived
public Path getTrashDir()

getOfflineLogDir

@Value.Derived
public Path getOfflineLogDir()

getRemoteSandboxDir

@Value.Derived
public Path getRemoteSandboxDir()

getLastOutputDir

@Value.Derived
public Path getLastOutputDir()

getEmbeddedCellsBuckOutBaseDir

@Value.Derived
public Path getEmbeddedCellsBuckOutBaseDir()

getProjectRootDir

@Value.Derived
public Path getProjectRootDir()

getSymlinkPathForDir

public Path getSymlinkPathForDir(Path unconfiguredDirInBuckOut)

of

public static BuckPaths of(CanonicalCellName cellName,
                           Path buckOut,
                           Path configuredBuckOut,
                           boolean shouldIncludeTargetConfigHash)

withConfiguredBuckOut

public BuckPaths withConfiguredBuckOut(Path configuredBuckOut)

withBuckOut

public BuckPaths withBuckOut(Path buckOut)