Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#nestedclasses) \| [Protected Ctors](https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#proctors) \| [Methods](https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#pubmethods) \| [Protected Methods](https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#promethods) \| [Inherited Methods](https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#inhmethods)
# AbstractQueuedLongSynchronizer
`
public
abstract
class
AbstractQueuedLongSynchronizer
`
`
`
`
extends https://developer.android.com/reference/java/util/concurrent/locks/AbstractOwnableSynchronizer
`
`
implements
https://developer.android.com/reference/java/io/Serializable
`
|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [java.util.concurrent.locks.AbstractOwnableSynchronizer](https://developer.android.com/reference/java/util/concurrent/locks/AbstractOwnableSynchronizer) ||
| | ↳ | java.util.concurrent.locks.AbstractQueuedLongSynchronizer |
*** ** * ** ***
A version of `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedSynchronizer` in
which synchronization state is maintained as a `long`.
This class has exactly the same structure, properties, and methods
as `AbstractQueuedSynchronizer` with the exception
that all state-related parameters and results are defined
as `long` rather than `int`. This class
may be useful when creating synchronizers such as
multilevel locks and barriers that require
64 bits of state.
See `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedSynchronizer` for usage
notes and examples.
## Summary
| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer.ConditionObject` Condition implementation for a `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer` serving as the basis of a `https://developer.android.com/reference/java/util/concurrent/locks/Lock` implementation. |
| ### Protected constructors ||
|---|---|
| ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#AbstractQueuedLongSynchronizer()() ` Constructor for subclasses to call. |
| ### Public methods ||
|---|---|
| ` final void` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#acquire(long)(long arg) ` Acquires in exclusive mode, ignoring interrupts. |
| ` final void` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#acquireInterruptibly(long)(long arg) ` Acquires in exclusive mode, aborting if interrupted. |
| ` final void` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#acquireShared(long)(long arg) ` Acquires in shared mode, ignoring interrupts. |
| ` final void` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#acquireSharedInterruptibly(long)(long arg) ` Acquires in shared mode, aborting if interrupted. |
| ` final https://developer.android.com/reference/java/util/Collection` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getExclusiveQueuedThreads()() ` Returns a collection containing threads that may be waiting to acquire in exclusive mode. |
| ` final https://developer.android.com/reference/java/lang/Thread` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getFirstQueuedThread()() ` Returns the first (longest-waiting) thread in the queue, or `null` if no threads are currently queued. |
| ` final int` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getQueueLength()() ` Returns an estimate of the number of threads waiting to acquire. |
| ` final https://developer.android.com/reference/java/util/Collection` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getQueuedThreads()() ` Returns a collection containing threads that may be waiting to acquire. |
| ` final https://developer.android.com/reference/java/util/Collection` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getSharedQueuedThreads()() ` Returns a collection containing threads that may be waiting to acquire in shared mode. |
| ` final int` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getWaitQueueLength(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.ConditionObject)(https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer.ConditionObject condition) ` Returns an estimate of the number of threads waiting on the given condition associated with this synchronizer. |
| ` final https://developer.android.com/reference/java/util/Collection` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getWaitingThreads(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.ConditionObject)(https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer.ConditionObject condition) ` Returns a collection containing those threads that may be waiting on the given condition associated with this synchronizer. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#hasContended()() ` Queries whether any threads have ever contended to acquire this synchronizer; that is, if an acquire method has ever blocked. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#hasQueuedPredecessors()() ` Queries whether any threads have been waiting to acquire longer than the current thread. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#hasQueuedThreads()() ` Queries whether any threads are waiting to acquire. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#hasWaiters(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.ConditionObject)(https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer.ConditionObject condition) ` Queries whether any threads are waiting on the given condition associated with this synchronizer. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#isQueued(java.lang.Thread)(https://developer.android.com/reference/java/lang/Thread thread) ` Returns true if the given thread is currently queued. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#owns(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.ConditionObject)(https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer.ConditionObject condition) ` Queries whether the given ConditionObject uses this synchronizer as its lock. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#release(long)(long arg) ` Releases in exclusive mode. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#releaseShared(long)(long arg) ` Releases in shared mode. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#toString()() ` Returns a string identifying this synchronizer, as well as its state. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireNanos(long,%20long)(long arg, long nanosTimeout) ` Attempts to acquire in exclusive mode, aborting if interrupted, and failing if the given timeout elapses. |
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireSharedNanos(long,%20long)(long arg, long nanosTimeout) ` Attempts to acquire in shared mode, aborting if interrupted, and failing if the given timeout elapses. |
| ### Protected methods ||
|---|---|
| ` final boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#compareAndSetState(long,%20long)(long expect, long update) ` Atomically sets synchronization state to the given updated value if the current state value equals the expected value. |
| ` final long` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getState()() ` Returns the current value of synchronization state. |
| ` boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#isHeldExclusively()() ` Returns `true` if synchronization is held exclusively with respect to the current (calling) thread. |
| ` final void` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#setState(long)(long newState) ` Sets the value of synchronization state. |
| ` boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)(long arg) ` Attempts to acquire in exclusive mode. |
| ` long` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)(long arg) ` Attempts to acquire in shared mode. |
| ` boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryRelease(long)(long arg) ` Attempts to set the state to reflect a release in exclusive mode. |
| ` boolean` | ` https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryReleaseShared(long)(long arg) ` Attempts to set the state to reflect a release in shared mode. |
### Inherited methods
From class `
https://developer.android.com/reference/java/util/concurrent/locks/AbstractOwnableSynchronizer
` `
final
https://developer.android.com/reference/java/lang/Thread` `
https://developer.android.com/reference/java/util/concurrent/locks/AbstractOwnableSynchronizer#getExclusiveOwnerThread()()
`
Returns the thread last set by `setExclusiveOwnerThread`,
or `null` if never set.
`
final
void` `
https://developer.android.com/reference/java/util/concurrent/locks/AbstractOwnableSynchronizer#setExclusiveOwnerThread(java.lang.Thread)(https://developer.android.com/reference/java/lang/Thread thread)
`
Sets the thread that currently owns exclusive access.
From class `
https://developer.android.com/reference/java/lang/Object
` `
https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`
Creates and returns a copy of this object.
`
boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`
Indicates whether some other object is "equal to" this one.
`
void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
`
final
https://developer.android.com/reference/java/lang/Class` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`
Returns the runtime class of this `Object`.
`
int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`
Returns a hash code value for the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`
Wakes up a single thread that is waiting on this object's
monitor.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`
Wakes up all threads that are waiting on this object's monitor.
`
https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`
Returns a string representation of the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos)
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis)
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait()()
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.
## Protected constructors
### AbstractQueuedLongSynchronizer
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected AbstractQueuedLongSynchronizer ()
```
Constructor for subclasses to call.
## Public methods
### acquire
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final void acquire (long arg)
```
Acquires in exclusive mode, ignoring interrupts. Implemented
by invoking at least once `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)`,
returning on success. Otherwise the thread is queued, possibly
repeatedly blocking and unblocking, invoking `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)` until success. This method can be used
to implement method `https://developer.android.com/reference/java/util/concurrent/locks/Lock#lock()`.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)` but is otherwise uninterpreted and can represent anything you like.
|
### acquireInterruptibly
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final void acquireInterruptibly (long arg)
```
Acquires in exclusive mode, aborting if interrupted.
Implemented by first checking interrupt status, then invoking
at least once `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)`, returning on
success. Otherwise the thread is queued, possibly repeatedly
blocking and unblocking, invoking `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)`
until success or the thread is interrupted. This method can be
used to implement method `https://developer.android.com/reference/java/util/concurrent/locks/Lock#lockInterruptibly()`.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)` but is otherwise uninterpreted and can represent anything you like.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/InterruptedException` | if the current thread is interrupted |
### acquireShared
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final void acquireShared (long arg)
```
Acquires in shared mode, ignoring interrupts. Implemented by
first invoking at least once `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)`,
returning on success. Otherwise the thread is queued, possibly
repeatedly blocking and unblocking, invoking `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)` until success.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)` but is otherwise uninterpreted and can represent anything you like.
|
### acquireSharedInterruptibly
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final void acquireSharedInterruptibly (long arg)
```
Acquires in shared mode, aborting if interrupted. Implemented
by first checking interrupt status, then invoking at least once
`https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)`, returning on success. Otherwise the
thread is queued, possibly repeatedly blocking and unblocking,
invoking `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)` until success or the thread
is interrupted.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)` but is otherwise uninterpreted and can represent anything you like.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/InterruptedException` | if the current thread is interrupted |
### getExclusiveQueuedThreads
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final Collection getExclusiveQueuedThreads ()
```
Returns a collection containing threads that may be waiting to
acquire in exclusive mode. This has the same properties
as `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getQueuedThreads()` except that it only returns
those threads waiting due to an exclusive acquire.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Collection` | the collection of threads
|
### getFirstQueuedThread
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final Thread getFirstQueuedThread ()
```
Returns the first (longest-waiting) thread in the queue, or
`null` if no threads are currently queued.
In this implementation, this operation normally returns in
constant time, but may iterate upon contention if other threads are
concurrently modifying the queue.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Thread` | the first (longest-waiting) thread in the queue, or `null` if no threads are currently queued
|
### getQueueLength
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final int getQueueLength ()
```
Returns an estimate of the number of threads waiting to
acquire. The value is only an estimate because the number of
threads may change dynamically while this method traverses
internal data structures. This method is designed for use in
monitoring system state, not for synchronization control.
| Returns ||
|---|---|
| `int` | the estimated number of threads waiting to acquire
|
### getQueuedThreads
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final Collection getQueuedThreads ()
```
Returns a collection containing threads that may be waiting to
acquire. Because the actual set of threads may change
dynamically while constructing this result, the returned
collection is only a best-effort estimate. The elements of the
returned collection are in no particular order. This method is
designed to facilitate construction of subclasses that provide
more extensive monitoring facilities.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Collection` | the collection of threads
|
### getSharedQueuedThreads
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final Collection getSharedQueuedThreads ()
```
Returns a collection containing threads that may be waiting to
acquire in shared mode. This has the same properties
as `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getQueuedThreads()` except that it only returns
those threads waiting due to a shared acquire.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Collection` | the collection of threads
|
### getWaitQueueLength
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final int getWaitQueueLength (AbstractQueuedLongSynchronizer.ConditionObject condition)
```
Returns an estimate of the number of threads waiting on the
given condition associated with this synchronizer. Note that
because timeouts and interrupts may occur at any time, the
estimate serves only as an upper bound on the actual number of
waiters. This method is designed for use in monitoring system
state, not for synchronization control.
| Parameters ||
|---|---|
| `condition` | `AbstractQueuedLongSynchronizer.ConditionObject`: the condition
|
| Returns ||
|---|---|
| `int` | the estimated number of waiting threads
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the given condition is not associated with this synchronizer |
| `https://developer.android.com/reference/java/lang/IllegalMonitorStateException` | if exclusive synchronization is not held |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the condition is null |
### getWaitingThreads
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final Collection getWaitingThreads (AbstractQueuedLongSynchronizer.ConditionObject condition)
```
Returns a collection containing those threads that may be
waiting on the given condition associated with this
synchronizer. Because the actual set of threads may change
dynamically while constructing this result, the returned
collection is only a best-effort estimate. The elements of the
returned collection are in no particular order.
| Parameters ||
|---|---|
| `condition` | `AbstractQueuedLongSynchronizer.ConditionObject`: the condition
|
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Collection` | the collection of threads
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the given condition is not associated with this synchronizer |
| `https://developer.android.com/reference/java/lang/IllegalMonitorStateException` | if exclusive synchronization is not held |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the condition is null |
### hasContended
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean hasContended ()
```
Queries whether any threads have ever contended to acquire this
synchronizer; that is, if an acquire method has ever blocked.
In this implementation, this operation returns in
constant time.
| Returns ||
|---|---|
| `boolean` | `true` if there has ever been contention
|
### hasQueuedPredecessors
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean hasQueuedPredecessors ()
```
Queries whether any threads have been waiting to acquire longer
than the current thread.
An invocation of this method is equivalent to (but may be
more efficient than):
getFirstQueuedThread() != Thread.currentThread()
&& hasQueuedThreads()
Note that because cancellations due to interrupts and
timeouts may occur at any time, a `true` return does not
guarantee that some other thread will acquire before the current
thread. Likewise, it is possible for another thread to win a
race to enqueue after this method has returned `false`,
due to the queue being empty.
This method is designed to be used by a fair synchronizer to
avoid [barging](https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedSynchronizer#barging).
Such a synchronizer's `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)` method should return
`false`, and its `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)` method should
return a negative value, if this method returns `true`
(unless this is a reentrant acquire). For example, the `tryAcquire` method for a fair, reentrant, exclusive mode
synchronizer might look like this:
protected boolean tryAcquire(long arg) {
if (isHeldExclusively()) {
// A reentrant acquire; increment hold count
return true;
} else if (hasQueuedPredecessors()) {
return false;
} else {
// try to acquire normally
}
}
| Returns ||
|---|---|
| `boolean` | `true` if there is a queued thread preceding the current thread, and `false` if the current thread is at the head of the queue or the queue is empty
|
### hasQueuedThreads
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean hasQueuedThreads ()
```
Queries whether any threads are waiting to acquire. Note that
because cancellations due to interrupts and timeouts may occur
at any time, a `true` return does not guarantee that any
other thread will ever acquire.
| Returns ||
|---|---|
| `boolean` | `true` if there may be other threads waiting to acquire
|
### hasWaiters
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean hasWaiters (AbstractQueuedLongSynchronizer.ConditionObject condition)
```
Queries whether any threads are waiting on the given condition
associated with this synchronizer. Note that because timeouts
and interrupts may occur at any time, a `true` return
does not guarantee that a future `signal` will awaken
any threads. This method is designed primarily for use in
monitoring of the system state.
| Parameters ||
|---|---|
| `condition` | `AbstractQueuedLongSynchronizer.ConditionObject`: the condition
|
| Returns ||
|---|---|
| `boolean` | `true` if there are any waiting threads
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the given condition is not associated with this synchronizer |
| `https://developer.android.com/reference/java/lang/IllegalMonitorStateException` | if exclusive synchronization is not held |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the condition is null |
### isQueued
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean isQueued (Thread thread)
```
Returns true if the given thread is currently queued.
This implementation traverses the queue to determine
presence of the given thread.
| Parameters ||
|---|---|
| `thread` | `Thread`: the thread
|
| Returns ||
|---|---|
| `boolean` | `true` if the given thread is on the queue
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the thread is null |
### owns
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean owns (AbstractQueuedLongSynchronizer.ConditionObject condition)
```
Queries whether the given ConditionObject
uses this synchronizer as its lock.
| Parameters ||
|---|---|
| `condition` | `AbstractQueuedLongSynchronizer.ConditionObject`: the condition
|
| Returns ||
|---|---|
| `boolean` | `true` if owned
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the condition is null |
### release
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean release (long arg)
```
Releases in exclusive mode. Implemented by unblocking one or
more threads if `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryRelease(long)` returns true.
This method can be used to implement method `https://developer.android.com/reference/java/util/concurrent/locks/Lock#unlock()`.
| Parameters ||
|---|---|
| `arg` | `long`: the release argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryRelease(long)` but is otherwise uninterpreted and can represent anything you like.
|
| Returns ||
|---|---|
| `boolean` | the value returned from `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryRelease(long)`
|
### releaseShared
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean releaseShared (long arg)
```
Releases in shared mode. Implemented by unblocking one or more
threads if `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryReleaseShared(long)` returns true.
| Parameters ||
|---|---|
| `arg` | `long`: the release argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryReleaseShared(long)` but is otherwise uninterpreted and can represent anything you like.
|
| Returns ||
|---|---|
| `boolean` | the value returned from `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryReleaseShared(long)`
|
### toString
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string identifying this synchronizer, as well as its state.
The state, in brackets, includes the String `"State ="`
followed by the current value of `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#getState()`, and either
`"nonempty"` or `"empty"` depending on whether the
queue is empty.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string identifying this synchronizer, as well as its state
|
### tryAcquireNanos
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean tryAcquireNanos (long arg,
long nanosTimeout)
```
Attempts to acquire in exclusive mode, aborting if interrupted,
and failing if the given timeout elapses. Implemented by first
checking interrupt status, then invoking at least once `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)`, returning on success. Otherwise, the thread is
queued, possibly repeatedly blocking and unblocking, invoking
`https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)` until success or the thread is interrupted
or the timeout elapses. This method can be used to implement
method `https://developer.android.com/reference/java/util/concurrent/locks/Lock#tryLock(long,%20java.util.concurrent.TimeUnit)`.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquire(long)` but is otherwise uninterpreted and can represent anything you like.
|
| `nanosTimeout` | `long`: the maximum number of nanoseconds to wait
|
| Returns ||
|---|---|
| `boolean` | `true` if acquired; `false` if timed out
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/InterruptedException` | if the current thread is interrupted |
### tryAcquireSharedNanos
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public final boolean tryAcquireSharedNanos (long arg,
long nanosTimeout)
```
Attempts to acquire in shared mode, aborting if interrupted, and
failing if the given timeout elapses. Implemented by first
checking interrupt status, then invoking at least once `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)`, returning on success. Otherwise, the
thread is queued, possibly repeatedly blocking and unblocking,
invoking `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)` until success or the thread
is interrupted or the timeout elapses.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is conveyed to `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer#tryAcquireShared(long)` but is otherwise uninterpreted and can represent anything you like.
|
| `nanosTimeout` | `long`: the maximum number of nanoseconds to wait
|
| Returns ||
|---|---|
| `boolean` | `true` if acquired; `false` if timed out
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/InterruptedException` | if the current thread is interrupted |
## Protected methods
### compareAndSetState
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected final boolean compareAndSetState (long expect,
long update)
```
Atomically sets synchronization state to the given updated
value if the current state value equals the expected value.
This operation has memory semantics of a `volatile` read
and write.
| Parameters ||
|---|---|
| `expect` | `long`: the expected value
|
| `update` | `long`: the new value
|
| Returns ||
|---|---|
| `boolean` | `true` if successful. False return indicates that the actual value was not equal to the expected value.
|
### getState
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected final long getState ()
```
Returns the current value of synchronization state.
This operation has memory semantics of a `volatile` read.
| Returns ||
|---|---|
| `long` | current state value
|
### isHeldExclusively
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean isHeldExclusively ()
```
Returns `true` if synchronization is held exclusively with
respect to the current (calling) thread. This method is invoked
upon each call to a `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer.ConditionObject` method.
The default implementation throws `https://developer.android.com/reference/java/lang/UnsupportedOperationException`. This method is invoked
internally only within `https://developer.android.com/reference/java/util/concurrent/locks/AbstractQueuedLongSynchronizer.ConditionObject` methods, so need
not be defined if conditions are not used.
| Returns ||
|---|---|
| `boolean` | `true` if synchronization is held exclusively; `false` otherwise
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if conditions are not supported |
### setState
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected final void setState (long newState)
```
Sets the value of synchronization state.
This operation has memory semantics of a `volatile` write.
| Parameters ||
|---|---|
| `newState` | `long`: the new state value
|
### tryAcquire
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean tryAcquire (long arg)
```
Attempts to acquire in exclusive mode. This method should query
if the state of the object permits it to be acquired in the
exclusive mode, and if so to acquire it.
This method is always invoked by the thread performing
acquire. If this method reports failure, the acquire method
may queue the thread, if it is not already queued, until it is
signalled by a release from some other thread. This can be used
to implement method `https://developer.android.com/reference/java/util/concurrent/locks/Lock#tryLock()`.
The default
implementation throws `https://developer.android.com/reference/java/lang/UnsupportedOperationException`.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is always the one passed to an acquire method, or is the value saved on entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like.
|
| Returns ||
|---|---|
| `boolean` | `true` if successful. Upon success, this object has been acquired.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalMonitorStateException` | if acquiring would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if exclusive mode is not supported |
### tryAcquireShared
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected long tryAcquireShared (long arg)
```
Attempts to acquire in shared mode. This method should query if
the state of the object permits it to be acquired in the shared
mode, and if so to acquire it.
This method is always invoked by the thread performing
acquire. If this method reports failure, the acquire method
may queue the thread, if it is not already queued, until it is
signalled by a release from some other thread.
The default implementation throws `https://developer.android.com/reference/java/lang/UnsupportedOperationException`.
| Parameters ||
|---|---|
| `arg` | `long`: the acquire argument. This value is always the one passed to an acquire method, or is the value saved on entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like.
|
| Returns ||
|---|---|
| `long` | a negative value on failure; zero if acquisition in shared mode succeeded but no subsequent shared-mode acquire can succeed; and a positive value if acquisition in shared mode succeeded and subsequent shared-mode acquires might also succeed, in which case a subsequent waiting thread must check availability. (Support for three different return values enables this method to be used in contexts where acquires only sometimes act exclusively.) Upon success, this object has been acquired.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalMonitorStateException` | if acquiring would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if shared mode is not supported |
### tryRelease
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean tryRelease (long arg)
```
Attempts to set the state to reflect a release in exclusive
mode.
This method is always invoked by the thread performing release.
The default implementation throws
`https://developer.android.com/reference/java/lang/UnsupportedOperationException`.
| Parameters ||
|---|---|
| `arg` | `long`: the release argument. This value is always the one passed to a release method, or the current state value upon entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like.
|
| Returns ||
|---|---|
| `boolean` | `true` if this object is now in a fully released state, so that any waiting threads may attempt to acquire; and `false` otherwise.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalMonitorStateException` | if releasing would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if exclusive mode is not supported |
### tryReleaseShared
Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean tryReleaseShared (long arg)
```
Attempts to set the state to reflect a release in shared mode.
This method is always invoked by the thread performing release.
The default implementation throws
`https://developer.android.com/reference/java/lang/UnsupportedOperationException`.
| Parameters ||
|---|---|
| `arg` | `long`: the release argument. This value is always the one passed to a release method, or the current state value upon entry to a condition wait. The value is otherwise uninterpreted and can represent anything you like.
|
| Returns ||
|---|---|
| `boolean` | `true` if this release of shared mode may permit a waiting acquire (shared or exclusive) to succeed; and `false` otherwise
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalMonitorStateException` | if releasing would place this synchronizer in an illegal state. This exception must be thrown in a consistent fashion for synchronization to work correctly. |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if shared mode is not supported |