org.gradle.cache

Interface PersistentCache

All Superinterfaces:

CacheAccess

All Known Implementing Classes:

DefaultPersistentDirectoryCache, DefaultPersistentDirectoryStore

public interface PersistentCache
extends CacheAccess

Represents a directory that can be used for caching.

By default, a shared lock is held on this cache by this process, to prevent it being removed or rebuilt by another process while it is in use. You can change this use DirectoryCacheBuilder.withLockMode(org.gradle.cache.internal.FileLockManager.LockMode).

You can use DirectoryCacheBuilder.withInitializer(org.gradle.api.Action) to provide an action to initialize the contents of the cache, for building a read-only cache. An exclusive lock is held by this process while the initializer is running.

You can also use CacheAccess.useCache(String, org.gradle.internal.Factory) to perform some action on the cache while holding an exclusive lock on the cache.

Method Summary

Methods

Modifier and Type	Method and Description
<K,V> PersistentIndexedCache<K,V>	createCache(File cacheFile, Class<K> keyType, Class<V> valueType) Creates an indexed cache implementation that is contained within this cache.
<K,V> PersistentIndexedCache<K,V>	createCache(File cacheFile, Class<K> keyType, Serializer<V> valueSerializer) Creates an indexed cache implementation that is contained within this cache.
File	getBaseDir() Returns the base directory for this cache.

Methods inherited from interface org.gradle.cache.CacheAccess

longRunningOperation, longRunningOperation, useCache, useCache

Method Detail

getBaseDir

File getBaseDir()

Returns the base directory for this cache.

createCache

<K,V> PersistentIndexedCache<K,V> createCache(File cacheFile,
                                            Class<K> keyType,
                                            Class<V> valueType)

Creates an indexed cache implementation that is contained within this cache. This method may be used at any time.

The returned cache may only be used by an action being run from CacheAccess.useCache(String, org.gradle.internal.Factory). In this instance, an exclusive lock will be held on the cache.

The returned cache may not be used by an action being run from CacheAccess.longRunningOperation(String, org.gradle.internal.Factory).

createCache

<K,V> PersistentIndexedCache<K,V> createCache(File cacheFile,
                                            Class<K> keyType,
                                            Serializer<V> valueSerializer)

Creates an indexed cache implementation that is contained within this cache. This method may be used at any time.

The returned cache may only be used by an action being run from CacheAccess.useCache(String, org.gradle.internal.Factory). In this instance, an exclusive lock will be held on the cache.

The returned cache may not be used by an action being run from CacheAccess.longRunningOperation(String, org.gradle.internal.Factory).