org.gradle.cache.internal

Interface FileLockManager

All Known Implementing Classes:

DefaultFileLockManager

public interface FileLockManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileLockManager.LockMode

Method Summary

Methods

Modifier and Type	Method and Description
FileLock	lock(File target, FileLockManager.LockMode mode, String targetDisplayName) Creates a locks for the given file with the given mode.
FileLock	lock(File target, FileLockManager.LockMode mode, String targetDisplayName, String operationDisplayName) Creates a locks for the given file with the given mode.

Method Detail

lock

FileLock lock(File target,
            FileLockManager.LockMode mode,
            String targetDisplayName)
              throws LockTimeoutException

Creates a locks for the given file with the given mode. Acquires a lock with the given mode, which is held until the lock is released by calling FileLock.close(). This method blocks until the lock can be acquired.

Parameters:

target - The file to be locked.

mode - The lock mode.

targetDisplayName - A display name for the target file. This is used in log and error messages.

Throws:

LockTimeoutException

lock

FileLock lock(File target,
            FileLockManager.LockMode mode,
            String targetDisplayName,
            String operationDisplayName)
              throws LockTimeoutException

Creates a locks for the given file with the given mode. Acquires a lock with the given mode, which is held until the lock is released by calling FileLock.close(). This method blocks until the lock can be acquired.

Parameters:

target - The file to be locked.

mode - The lock mode.

targetDisplayName - A display name for the target file. This is used in log and error messages.

operationDisplayName - A display name for the operation being performed on the target file. This is used in log and error messages.

Throws:

LockTimeoutException