org.gradle.cache

Interface CacheRepository

All Known Implementing Classes:

DefaultCacheRepository

public interface CacheRepository

A repository of persistent caches and stores. A store is a store for persistent data. A cache is a store for persistent cache data. The only real difference between the two is that a store cannot be invalidated, whereas a cache can be invalidated when things change. For example, running with --cache rebuild will invalidate the contents of all caches, but not the contents of any stores.

There are 3 types of caches and stores:

• A directory backed store, represented by PersistentCache. The caller is responsible for managing the contents of this directory.
• An indexed store, essentially a persistent Map, represented by PersistentIndexedCache.
• A state store, essentially a persistent AtomicReference, represented by PersistentStateCache.

Method Summary

Methods

Modifier and Type	Method and Description
DirectoryCacheBuilder	cache(String key) Returns a builder for the cache with the given key.
<K,V> ObjectCacheBuilder<V,PersistentIndexedCache<K,V>>	indexedCache(Class<K> keyType, Class<V> elementType, String key) Returns a builder for the indexed cache with the given key.
<E> ObjectCacheBuilder<E,PersistentStateCache<E>>	stateCache(Class<E> elementType, String key) Returns a builder for the state cache with the given key.
DirectoryCacheBuilder	store(String key) Returns a builder for the store with the given key.

Method Detail

store

DirectoryCacheBuilder store(String key)

Returns a builder for the store with the given key. Default is a Gradle version-specific store shared by all builds, though this can be changed using the given builder.

A store is always opened with a shared lock, so that it can be accessed by multiple processes. It is the caller's responsibility to coordinate access to the cache.

Parameters:

key - The cache key.

Returns:

The builder.

cache

DirectoryCacheBuilder cache(String key)

Returns a builder for the cache with the given key. Default is a Gradle version-specific cache shared by all builds, though this can be changed using the given builder.

A state cache is always opened with a shared lock, so that it can be accessed by multiple processes. It is the caller's responsibility to coordinate access to the cache.

Parameters:

key - The cache key.

Returns:

The builder.

stateCache

<E> ObjectCacheBuilder<E,PersistentStateCache<E>> stateCache(Class<E> elementType,
                                                           String key)

Returns a builder for the state cache with the given key. Default is a Gradle version-specific cache shared by all builds, though this can be changed using the given builder.

A state cache is always opened with an exclusive lock, so that it can be accessed only by this process.

Parameters:

key - The cache key.

elementType - The type of element kept in the cache.

Returns:

The builder.

indexedCache

<K,V> ObjectCacheBuilder<V,PersistentIndexedCache<K,V>> indexedCache(Class<K> keyType,
                                                                   Class<V> elementType,
                                                                   String key)

Returns a builder for the indexed cache with the given key. Default is a Gradle version-specific cache shared by all builds, though this can be changed using the given builder.

An indexed cache is always opened with an exclusive lock, so that it can be accessed only by this process.

Parameters:

key - The cache key.

keyType - The type of key kept in the cache.

elementType - The type of element kept in the cache.

Returns:

The builder.