AutoLock (Common 1.0.0 API)

java.lang.Object
- org.somda.sdc.common.util.AutoLock<T>

All Implemented Interfaces:: AutoCloseable, Lock

public class AutoLock<T extends Lock>
extends Object
implements Lock, AutoCloseable

Converts locks to auto-closables.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`T`	`getLock()`	Returns the wrapped lock instance.
`void`	`lock()`
`static <T extends Lock> AutoLock`	`lock(T lock)`	Locks the given lock and return auto-closable variant.
`void`	`lockInterruptibly()`
`Condition`	`newCondition()`
`boolean`	`tryLock()`
`boolean`	`tryLock(long time, TimeUnit unit)`
`void`	`unlock()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - lock
```
public static <T extends Lock> AutoLock lock(T lock)
```
    Locks the given lock and return auto-closable variant.
    
    Type Parameters:
    
    T - type of the lock (write/read/common).
    
    Parameters:
    
    lock - the lock to wrap.
    
    Returns:
    
    an auto-closable instance to be used with try (...) { ... }.
  - getLock
```
public T getLock()
```
    Returns the wrapped lock instance.
    
    Returns:
    
    the wrapped lock.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - lock
```
public void lock()
```
    Specified by:
    
    lock in interface Lock
  - lockInterruptibly
```
public void lockInterruptibly()
                       throws InterruptedException
```
    Specified by:
    
    lockInterruptibly in interface Lock
    
    Throws:
    
    InterruptedException
  - tryLock
```
public boolean tryLock()
```
    Specified by:
    
    tryLock in interface Lock
  - tryLock
```
public boolean tryLock(long time,
                       TimeUnit unit)
                throws InterruptedException
```
    Specified by:
    
    tryLock in interface Lock
    
    Throws:
    
    InterruptedException
  - unlock
```
public void unlock()
```
    Specified by:
    
    unlock in interface Lock
  - newCondition
```
public Condition newCondition()
```
    Specified by:
    
    newCondition in interface Lock