com.facebook.buck.parser.manifest

Class BuildFileManifestCache

java.lang.Object

com.facebook.buck.parser.manifest.BuildFileManifestCache

All Implemented Interfaces:

GraphEngineCache<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

public class BuildFileManifestCache
extends Object
implements GraphEngineCache<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Stores BuildFileManifest for each parsed build file

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildFileManifestCache.Invalidator Subscribes to watchman event and invalidates internal state of a provided BuildFileManifestCache

Method Summary

Modifier and Type	Method and Description
Optional<BuildFileManifest>	get(BuildPackagePathToBuildFileManifestKey key) Optionally returns the cached result given the key
BuildFileManifestCache.Invalidator	getInvalidator()
static BuildFileManifestCache	of(Path superRootPath, Path rootPath, Path buildFileName, ProjectFilesystemView fileSystemView) Create a new instance of BuildFileManifestCache
void	put(BuildPackagePathToBuildFileManifestKey key, BuildFileManifest buildFileManifest) Offers the given key and value for caching

Methods inherited from class java.lang.Object

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

Method Detail

of

public static BuildFileManifestCache of(Path superRootPath,
                                        Path rootPath,
                                        Path buildFileName,
                                        ProjectFilesystemView fileSystemView)

Create a new instance of BuildFileManifestCache

Parameters:

superRootPath - Absolute path to the cell root folder which contains all other cells. All files and includes should be descendants of this path.

rootPath - Absolute path to the root folder for which files and subfolders are cached, this is usually the root path of the cell. It may be the same path as superRootPath or a subfolder of it.

buildFileName - File name of the build file (for example, BUCK) in a form of a Path

fileSystemView - ProjectFilesystemView that is used to physically access files, used for invalidations

get

public Optional<BuildFileManifest> get(BuildPackagePathToBuildFileManifestKey key)

Description copied from interface: GraphEngineCache

Optionally returns the cached result given the key

Specified by:

get in interface GraphEngineCache<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Parameters:

key - The desired key

Returns:

the result if cached, otherwise an empty Optional

put

public void put(BuildPackagePathToBuildFileManifestKey key,
                BuildFileManifest buildFileManifest)

Description copied from interface: GraphEngineCache

Offers the given key and value for caching

Specified by:

put in interface GraphEngineCache<BuildPackagePathToBuildFileManifestKey,BuildFileManifest>

Parameters:

key - the key to cache

buildFileManifest - the value to cache

getInvalidator

public BuildFileManifestCache.Invalidator getInvalidator()

Returns:

class that listens to watchman events and invalidates internal cache state