com.facebook.buck.rules.keys

Class RuleKeyCacheRecycler<V>

java.lang.Object

com.facebook.buck.rules.keys.RuleKeyCacheRecycler<V>

public class RuleKeyCacheRecycler<V>
extends Object

Class which encapsulates all effort to cache and reuse a RuleKeyCache between builds.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuleKeyCacheRecycler.SettingsAffectingCache Any external settings which, if changed, will cause the entire cache to be invalidated.

Method Summary

Modifier and Type	Method and Description
static <V> RuleKeyCacheRecycler<V>	create(TrackableRuleKeyCache<V> ruleKeyCache)
static <V> RuleKeyCacheRecycler<V>	createAndRegister(com.google.common.eventbus.EventBus eventBus, TrackableRuleKeyCache<V> ruleKeyCache, com.google.common.collect.ImmutableSet<ProjectFilesystem> watchedFilesystems)
com.google.common.collect.ImmutableList<Map.Entry<BuildRule,V>>	getCachedBuildRules()
void	invalidatePath(ProjectFilesystem filesystem, Path path)
void	onFilesystemChange(WatchmanOverflowEvent event)
void	onFilesystemChange(WatchmanPathEvent event)
RuleKeyCacheScope<V>	withRecycledCache(BuckEventBus buckEventBus, RuleKeyCacheRecycler.SettingsAffectingCache currentSettings) Provides access to a RuleKeyCache via a RuleKeyCacheScope.

Methods inherited from class java.lang.Object

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

Method Detail

createAndRegister

public static <V> RuleKeyCacheRecycler<V> createAndRegister(com.google.common.eventbus.EventBus eventBus,
                                                            TrackableRuleKeyCache<V> ruleKeyCache,
                                                            com.google.common.collect.ImmutableSet<ProjectFilesystem> watchedFilesystems)

Parameters:

eventBus - EventBus which delivers watchman events.

watchedFilesystems - all ProjectFilesystems which use watchman to receive events when files are changed.

Returns:

a new RuleKeyCacheRecycler.

create

public static <V> RuleKeyCacheRecycler<V> create(TrackableRuleKeyCache<V> ruleKeyCache)

onFilesystemChange

public void onFilesystemChange(WatchmanPathEvent event)

invalidatePath

public void invalidatePath(ProjectFilesystem filesystem,
                           Path path)

onFilesystemChange

public void onFilesystemChange(WatchmanOverflowEvent event)

withRecycledCache

public RuleKeyCacheScope<V> withRecycledCache(BuckEventBus buckEventBus,
                                              RuleKeyCacheRecycler.SettingsAffectingCache currentSettings)

Provides access to a RuleKeyCache via a RuleKeyCacheScope. The RuleKeyCacheScope must be used with a try-resource block and does logging and cache invalidation both before and after being used.

Returns:

a RuleKeyCacheScope managing access to enclosed RuleKeyCache.

getCachedBuildRules

public com.google.common.collect.ImmutableList<Map.Entry<BuildRule,V>> getCachedBuildRules()