GlueGen: src/java/com/jogamp/common/util/locks/ThreadLock.java Source File

GlueGen v2.6.0 GlueGen, Native Binding Generator for Java™ (public API).

ThreadLock.java
Go to the documentation of this file.
1/**
2 * Copyright 2010 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28
29package com.jogamp.common.util.locks;
30
31/**
32 * Extending the {@link Lock} features with convenient functionality.
33 */
34 public interface ThreadLock extends Lock {
35
36 /** Query whether the lock is hold by the a thread other than the current thread. */
37 boolean isLockedByOtherThread();
38
39 /** Query whether the lock is hold by the given thread. */
40 boolean isOwner(Thread thread);
41
42 /**
43 * @return the Thread owning this lock if locked, otherwise null
44 */
45 Thread getOwner();
46
47 /**
48 * @throws RuntimeException if current thread does not hold the lock
49 */
50 void validateLocked() throws RuntimeException;
51
52 /**
53 * Execute the {@link Runnable Runnable taskAfterUnlockBeforeNotify} while holding the exclusive lock.
54 * <p>
55 * Then release the lock.
56 * </p>
57 */
58 void unlock(Runnable taskAfterUnlockBeforeNotify);
59}
com.jogamp.common.util.locks.Lock
Specifying a thread blocking lock implementation.
Definition: Lock.java:36
com.jogamp.common.util.locks.Lock.unlock
void unlock()
Release the lock.
com.jogamp.common.util.locks.ThreadLock
Extending the Lock features with convenient functionality.
Definition: ThreadLock.java:34
com.jogamp.common.util.locks.ThreadLock.getOwner
Thread getOwner()
com.jogamp.common.util.locks.ThreadLock.isLockedByOtherThread
boolean isLockedByOtherThread()
Query whether the lock is hold by the a thread other than the current thread.
com.jogamp.common.util.locks.ThreadLock.validateLocked
void validateLocked()
com.jogamp.common.util.locks.ThreadLock.isOwner
boolean isOwner(Thread thread)
Query whether the lock is hold by the given thread.