org.gradle.cache.internal

Interface FileAccess

All Known Subinterfaces:

FileLock

All Known Implementing Classes:

AbstractFileAccess, OnDemandFileAccess

public interface FileAccess

Provides synchronization with other processes for a particular file.

Method Summary

Methods

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

Method Detail

readFromFile

<T> T readFromFile(Callable<? extends T> action)
               throws LockTimeoutException

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.

IllegalStateException - When this lock has been closed.

readFromFile

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

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.

IllegalStateException - When this lock has been closed.

writeToFile

void writeToFile(Runnable action)
                 throws LockTimeoutException

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.

IllegalStateException - When this lock has been closed.