Improved locking documentation

This commit is contained in:
leventov
2015-05-29 03:26:29 +01:00
parent 177f3996c1
commit 02fd928d25
4 changed files with 261 additions and 13 deletions
@@ -10,7 +10,14 @@ package net.openhft.chronicle.hash;
public interface ExternalHashQueryContext<K> extends HashQueryContext<K>, AutoCloseable {
/**
* Could throw only unchecked exception.
* Closes the query context, automatically releases all locks and disposes all resources,
* acquired during the query operation. I. e. you shouldn't release locks manually in the end
* of try-with-resources statement: <pre>{@code
* try (ExternalHashQueryContext<K> q = hash.queryContext(key))
* q.writeLock().lock();
* // ...make a query under exclusive lock
* // NOT NEEDED - q.readLock().unlock();
* }}</pre>
*/
@Override
void close();