com.facebook.buck.core.files

Class FileTreeCache

java.lang.Object

com.facebook.buck.core.files.FileTreeCache

All Implemented Interfaces:

GraphEngineCache<FileTreeKey,FileTree>

public class FileTreeCache
extends Object
implements GraphEngineCache<FileTreeKey,FileTree>

Stores a recursive file tree

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Optional<FileTree>	get(FileTreeKey key) Optionally returns the cached result given the key
FileTreeCache.Invalidator	getInvalidator()
static FileTreeCache	of(Path rootPath) Create a new instance of FileTreeCache
void	put(FileTreeKey key, FileTree fileTree) 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 FileTreeCache of(Path rootPath)

Create a new instance of FileTreeCache

Parameters:

rootPath - Absolute path to the root folder for which files and subfolders are cached, this is usually the root path of the cell

get

public Optional<FileTree> get(FileTreeKey key)

Description copied from interface: GraphEngineCache

Optionally returns the cached result given the key

Specified by:

get in interface GraphEngineCache<FileTreeKey,FileTree>

Parameters:

key - The desired key

Returns:

the result if cached, otherwise an empty Optional

put

public void put(FileTreeKey key,
                FileTree fileTree)

Description copied from interface: GraphEngineCache

Offers the given key and value for caching

Specified by:

put in interface GraphEngineCache<FileTreeKey,FileTree>

Parameters:

key - the key to cache

fileTree - the value to cache

getInvalidator

public FileTreeCache.Invalidator getInvalidator()

Returns:

class that listens to watchman events and invalidates internal cache state