Commit b0f283d5 authored by Ard Schrijvers's avatar Ard Schrijvers

CMS-10897 improve java doc

parent 5c36543e
......@@ -72,12 +72,13 @@ import org.onehippo.cms7.services.SingletonService;
* </code>
* </p>
* <p>
* Note that when a {@code key} is already locked, the invocation of {@link #lock(String) #lock(key)} directly results
* in an {@link AlreadyLockedException} : This is thus <strong>different</strong> than
* {@link java.util.concurrent.locks.ReentrantLock} behavior. If you need similar behavior to {@link ReentrantLock#lock()}
* but then <strong>cluster wide</strong>, you can use {@link LockManagerUtils#waitForLock(LockManager, String, long)}
* and if you need the cluster wide equivalent of {@link java.util.concurrent.locks.ReentrantLock#tryLock(long, TimeUnit)}
* you can use {@link LockManagerUtils#waitForLock(LockManager, String, long, long)}.
* Note that when {@code key} is already locked by another {@link Thread} or other cluster node,
* the invocation of {@link #lock(String) #lock(key)} directly results in an {@link AlreadyLockedException} :
* This is thus <strong>different</strong> than {@link java.util.concurrent.locks.ReentrantLock} behavior. If you
* need similar behavior to {@link ReentrantLock#lock()} but then <strong>cluster wide</strong>, you can use
* {@link LockManagerUtils#waitForLock(LockManager, String, long)} and if you need the cluster wide equivalent
* of {@link java.util.concurrent.locks.ReentrantLock#tryLock(long, TimeUnit)} you can use
* {@link LockManagerUtils#waitForLock(LockManager, String, long, long)}.
* </p>
*
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment