org.gradle.cache.internal

Class DefaultFileLockManager

java.lang.Object

org.gradle.cache.internal.DefaultFileLockManager

All Implemented Interfaces:

FileLockManager

public class DefaultFileLockManager
extends Object
implements FileLockManager

Uses file system locks on a lock file per target file. Each lock file is made up of 2 regions:

• State region: 1 byte version field, 1 byte clean flag.
• Owner information region: 1 byte version field, utf-8 encoded owner process id, utf-8 encoded owner operation display name.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.cache.internal.FileLockManager

FileLockManager.LockMode

Constructor Summary

Constructors

Constructor and Description
DefaultFileLockManager(ProcessMetaDataProvider metaDataProvider)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFileLockManager

public DefaultFileLockManager(ProcessMetaDataProvider metaDataProvider)

Method Detail

lock

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

Description copied from interface: FileLockManager

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.

Specified by:

lock in interface FileLockManager

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

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

Description copied from interface: FileLockManager

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.

Specified by:

lock in interface FileLockManager

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.