org.gradle.cache.internal

Class DefaultPersistentDirectoryStore

java.lang.Object

org.gradle.cache.internal.DefaultPersistentDirectoryStore

All Implemented Interfaces:

CacheAccess, PersistentCache

Direct Known Subclasses:

DefaultPersistentDirectoryCache

public class DefaultPersistentDirectoryStore
extends Object
implements PersistentCache

Constructor Summary

Constructors

Constructor and Description
DefaultPersistentDirectoryStore(File dir, String displayName, FileLockManager.LockMode lockMode, FileLockManager fileLockManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
<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.
protected FileLock	getLock()
protected File	getLockTarget()
protected void	init()
<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).
DefaultPersistentDirectoryStore	open()
String	toString()
<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, wait, wait, wait

Constructor Detail

DefaultPersistentDirectoryStore

public DefaultPersistentDirectoryStore(File dir,
                               String displayName,
                               FileLockManager.LockMode lockMode,
                               FileLockManager fileLockManager)

Method Detail

open

public DefaultPersistentDirectoryStore open()

getLockTarget

protected File getLockTarget()

init

protected void init()
             throws IOException

Throws:

IOException

close

public void close()

getLock

protected FileLock getLock()

getBaseDir

public File getBaseDir()

Description copied from interface: PersistentCache

Returns the base directory for this cache.

Specified by:

getBaseDir in interface PersistentCache

toString

public String toString()

Overrides:

toString in class Object

createCache

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

Description copied from interface: PersistentCache

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).

Specified by:

createCache in interface PersistentCache

createCache

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

Description copied from interface: PersistentCache

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).

Specified by:

createCache in interface PersistentCache

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

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

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