org.gradle.cache.internal

Class OnDemandFileAccess

java.lang.Object

org.gradle.cache.internal.AbstractFileAccess

org.gradle.cache.internal.OnDemandFileAccess

All Implemented Interfaces:

FileAccess

public class OnDemandFileAccess
extends AbstractFileAccess

Constructor Summary

Constructors

Constructor and Description
OnDemandFileAccess(java.io.File targetFile, java.lang.String displayName, FileLockManager manager)

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	readFromFile(Factory<? extends T> action) Runs the given action under a shared or exclusive lock on the target file.
void	writeToFile(java.lang.Runnable action) Runs the given action under an exclusive lock on the target file.

Methods inherited from class org.gradle.cache.internal.AbstractFileAccess

readFromFile

Methods inherited from class java.lang.Object

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

Constructor Detail

OnDemandFileAccess

public OnDemandFileAccess(java.io.File targetFile,
                  java.lang.String displayName,
                  FileLockManager manager)

Method Detail

readFromFile

public <T> T readFromFile(Factory<? extends T> action)
               throws LockTimeoutException

Description copied from interface: FileAccess

Runs the given action under a shared or exclusive lock on the target file.

If an exclusive or shared lock is already held, the lock level is not changed and the action is executed. If no lock is already held, a shared lock is acquired, the action executed, and the lock released. This method blocks until the lock can be acquired.

Throws:

LockTimeoutException - On timeout acquiring lock, if required.

writeToFile

public void writeToFile(java.lang.Runnable action)
                 throws LockTimeoutException

Description copied from interface: FileAccess

Runs the given action under an exclusive lock on the target file. If the given action fails, the lock is marked as uncleanly unlocked.

If an exclusive lock is already held, the lock level is not changed and the action is executed. If a shared lock is already held, the lock is escalated to an exclusive lock, and reverted back to a shared lock when the action completes. If no lock is already held, an exclusive lock is acquired, the action executed, and the lock released.

Throws:

LockTimeoutException - On timeout acquiring lock, if required.