org.gradle.cache.internal

Class DefaultCacheAccess

java.lang.Object

org.gradle.cache.internal.DefaultCacheAccess

All Implemented Interfaces:

CacheAccess

@ThreadSafe
public class DefaultCacheAccess
extends Object
implements CacheAccess

Constructor Summary

Constructors

Constructor and Description
DefaultCacheAccess(String cacheDisplayName, File lockFile, FileLockManager lockManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
FileLock	getFileLock()
<T> T	longRunningOperation(String operationDisplayName, Factory<? extends T> action) Performs some long running operation within an action invoked by CacheAccess.useCache(String, org.gradle.internal.Factory).
void	longRunningOperation(String operationDisplayName, Runnable action) Performs some long running operation within an action invoked by CacheAccess.useCache(String, org.gradle.internal.Factory).
<K,V> PersistentIndexedCache<K,V>	newCache(File cacheFile, Class<K> keyType, Class<V> valueType)
<K,V> PersistentIndexedCache<K,V>	newCache(File cacheFile, Class<K> keyType, Serializer<V> valueSerializer)
void	open(FileLockManager.LockMode lockMode) Opens this cache access with the given lock mode.
<T> T	useCache(String operationDisplayName, Factory<? extends T> action) Performs some work against the cache.
void	useCache(String operationDisplayName, Runnable action) Performs some work against the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCacheAccess

public DefaultCacheAccess(String cacheDisplayName,
                  File lockFile,
                  FileLockManager lockManager)

Method Detail

open

public void open(FileLockManager.LockMode lockMode)

Opens this cache access with the given lock mode. Calling this with FileLockManager.LockMode.Exclusive will lock the cache for exclusive access from all other threads (including those in this process and all other processes), until close() is called.

close

public void close()

getFileLock

public FileLock getFileLock()

useCache

public void useCache(String operationDisplayName,
            Runnable action)

Description copied from interface: CacheAccess

Performs some work against the cache. Acquires exclusive locks the appropriate resources, so that the given action is the only action to execute across all processes (including this one). Releases the locks and all resources at the end of the action.

This method is re-entrant, so that an action can call back into this method.

Specified by:

useCache in interface CacheAccess

useCache

public <T> T useCache(String operationDisplayName,
             Factory<? extends T> action)

Description copied from interface: CacheAccess

Performs some work against the cache. Acquires exclusive locks the appropriate resources, so that the given action is the only action to execute across all processes (including this one). Releases the locks and all resources at the end of the action.

This method is re-entrant, so that an action can call back into this method.

Specified by:

useCache in interface CacheAccess

longRunningOperation

public <T> T longRunningOperation(String operationDisplayName,
                         Factory<? extends T> action)

Description copied from interface: CacheAccess

Performs some long running operation within an action invoked by CacheAccess.useCache(String, org.gradle.internal.Factory). Releases all locks while the operation is running, and reacquires the locks at the end of the long running operation.

This method is re-entrant, so that an action can call back into this method.

Specified by:

longRunningOperation in interface CacheAccess

longRunningOperation

public void longRunningOperation(String operationDisplayName,
                        Runnable action)

Description copied from interface: CacheAccess

Performs some long running operation within an action invoked by CacheAccess.useCache(String, org.gradle.internal.Factory). Releases all locks while the operation is running, and reacquires the locks at the end of the long running operation.

This method is re-entrant, so that an action can call back into this method.

Specified by:

longRunningOperation in interface CacheAccess

newCache

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

newCache

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