ExclusiveFileAccess (Grolifant Core API)

Summary:
Constructor
Method

| Detail:
Constructor
Method

org.ysb33r.grolifant5.api.core.ExclusiveFileAccess

```
@groovy.transform.CompileStatic
class ExclusiveFileAccess
extends Object
```
Provides co-operative exclusive file access.
This is typically used for files that might be shared between Gradle instances.
Since:
0.5

Constructor Summary

Constructors
Constructor and description
`ExclusiveFileAccess (int timeoutMs, int pollIntervalMs)` Create exclusive access guard and monitor.

Methods Summary

Methods
Type Params	Return Type	Name and description
`<T>`	`T`	`access(File onFile, groovy.lang.Closure<T> runner)` Lock access to a file and perform action.
`<T>`	`T`	`access(File onFile, java.util.concurrent.Callable<T> runner)` Lock access to a file and perform action.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Constructor Detail
  - ExclusiveFileAccess(int timeoutMs, int pollIntervalMs)
    
    Create exclusive access guard and monitor.
    Parameters:
    timeoutMs - Time (in milliseconds) to wait for a file to become available before giving up.
    pollIntervalMs - Polling interval (in milliseconds).
- Method Detail
  - <T> T access(File onFile, groovy.lang.Closure<T> runner)
    
    Lock access to a file and perform action.
    Parameters:
    onFile - File to wait for & lock access to.
    runner - Actions to execute whilst access is held.
  - <T> T access(File onFile, java.util.concurrent.Callable<T> runner)
    
    Lock access to a file and perform action.
    Parameters:
    onFile - File to wait for & lock access to.
    runner - Actions to execute whilst access is held.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation