com.facebook.buck.core.files

Class DirectoryListCache

java.lang.Object

com.facebook.buck.core.files.DirectoryListCache

All Implemented Interfaces:

GraphEngineCache<DirectoryListKey,DirectoryList>

public class DirectoryListCache
extends Object
implements GraphEngineCache<DirectoryListKey,DirectoryList>

Stores a list of files and subfolders per each folder

Nested Class Summary

Nested Classes

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

Method Summary

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

Create a new instance of DirectoryListCache

Parameters:

rootPath - Absolute path to the root folder for which files and subfolders are cached

get

public Optional<DirectoryList> get(DirectoryListKey key)

Description copied from interface: GraphEngineCache

Optionally returns the cached result given the key

Specified by:

get in interface GraphEngineCache<DirectoryListKey,DirectoryList>

Parameters:

key - The desired key

Returns:

the result if cached, otherwise an empty Optional

put

public void put(DirectoryListKey key,
                DirectoryList directoryList)

Description copied from interface: GraphEngineCache

Offers the given key and value for caching

Specified by:

put in interface GraphEngineCache<DirectoryListKey,DirectoryList>

Parameters:

key - the key to cache

directoryList - the value to cache

getInvalidator

public DirectoryListCache.Invalidator getInvalidator()

Returns:

class that listens to watchman events and invalidates internal cache state