OpenJDK 1.23 · java.lang.ref.NativeReferenceQueue · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	NativeReferenceQueue.Lock

Modifier and Type	Field and Description
private final NativeReferenceQueue.Lock	lock Hides java.lang.ref.ReferenceQueue.lock.

Access	Constructor and Description
public	NativeReferenceQueue()

Method Summary

Modifier and Type	Method and Description
pack-priv void	await() Overrides java.lang.ref.ReferenceQueue.await.
pack-priv void	await(long timeoutMillis) Overrides java.lang.ref.ReferenceQueue.await.
pack-priv boolean	enqueue(Reference<? extends T> r) Overrides java.lang.ref.ReferenceQueue.enqueue.
public Reference<? extends T>	poll() Overrides java.lang.ref.ReferenceQueue.poll. Polls this queue to see if a reference object is available.
public Reference<? extends T>	remove(long If positive, block for up to `timeout` milliseconds while waiting for a reference to be added to this queue. If zero, block indefinitely. timeout) Overrides java.lang.ref.ReferenceQueue.remove. Removes the next reference object in this queue, blocking until either one becomes available or the given timeout period expires.
public Reference<? extends T>	remove() Overrides java.lang.ref.ReferenceQueue.remove. Removes the next reference object in this queue, blocking until one becomes available.
pack-priv void	signal() Overrides java.lang.ref.ReferenceQueue.signal.

Inherited from java.lang.ref.ReferenceQueue:: enqueue0 forEach headIsNull poll0 remove0 remove0

lock	back to summary
private final NativeReferenceQueue.Lock lock Hides java.lang.ref.ReferenceQueue.lock.

NativeReferenceQueue	back to summary
public NativeReferenceQueue()

Method Detail

await	back to summary
pack-priv void await() throws InterruptedException Overrides java.lang.ref.ReferenceQueue.await. Annotations @Override

await

back to summary

pack-priv void await() throws InterruptedException

Overrides java.lang.ref.ReferenceQueue.await.

Annotations

@Override

await	back to summary
pack-priv void await(long timeoutMillis) throws InterruptedException Overrides java.lang.ref.ReferenceQueue.await. Annotations @Override

await

back to summary

pack-priv void await(long timeoutMillis) throws InterruptedException

Overrides java.lang.ref.ReferenceQueue.await.

Annotations

@Override

enqueue	back to summary
pack-priv boolean enqueue(Reference<? extends T> r) Overrides java.lang.ref.ReferenceQueue.enqueue. Annotations @Override

enqueue

back to summary

pack-priv boolean enqueue(Reference<? extends T> r)

Overrides java.lang.ref.ReferenceQueue.enqueue.

Annotations

@Override

poll back to summary

poll	back to summary
public Reference<? extends T> poll() Overrides java.lang.ref.ReferenceQueue.poll. Doc from java.lang.ref.ReferenceQueue.poll. Polls this queue to see if a reference object is available. If one is available without further delay then it is removed from the queue and returned. Otherwise this method immediately returns `null`. Returns:Reference<? extends T> A reference object, if one was immediately available, otherwise `null` Annotations @Override

public Reference<? extends T> poll()

Overrides java.lang.ref.ReferenceQueue.poll.

Doc from java.lang.ref.ReferenceQueue.poll.

Polls this queue to see if a reference object is available. If one is available without further delay then it is removed from the queue and returned. Otherwise this method immediately returns null.

Returns:Reference<? extends T>

A reference object, if one was immediately available, otherwise null

Annotations

@Override

remove back to summary

remove	back to summary
public Reference<? extends T> remove(long timeout) throws IllegalArgumentException, InterruptedException Overrides java.lang.ref.ReferenceQueue.remove. Doc from java.lang.ref.ReferenceQueue.remove. Removes the next reference object in this queue, blocking until either one becomes available or the given timeout period expires. This method does not offer real-time guarantees: It schedules the timeout as if by invoking the `Object#wait(long)` method. Parameters timeout:long If positive, block for up to `timeout` milliseconds while waiting for a reference to be added to this queue. If zero, block indefinitely. Returns:Reference<? extends T> A reference object, if one was available within the specified timeout period, otherwise `null` Annotations @Override Exceptions IllegalArgumentException: If the value of the timeout argument is negative InterruptedException: If the timeout wait is interrupted

public Reference<? extends T> remove(long timeout) throws IllegalArgumentException, InterruptedException

Overrides java.lang.ref.ReferenceQueue.remove.

Doc from java.lang.ref.ReferenceQueue.remove.

Removes the next reference object in this queue, blocking until either one becomes available or the given timeout period expires.

This method does not offer real-time guarantees: It schedules the timeout as if by invoking the Object#wait(long) method.

Parameters

timeout:long: If positive, block for up to timeout milliseconds while waiting for a reference to be added to this queue. If zero, block indefinitely.

Returns:Reference<? extends T>

A reference object, if one was available within the specified timeout period, otherwise null

Annotations

@Override

Exceptions

IllegalArgumentException:: If the value of the timeout argument is negative
InterruptedException:: If the timeout wait is interrupted

remove	back to summary
public Reference<? extends T> remove() throws InterruptedException Overrides java.lang.ref.ReferenceQueue.remove. Doc from java.lang.ref.ReferenceQueue.remove. Removes the next reference object in this queue, blocking until one becomes available. Returns:Reference<? extends T> A reference object, blocking until one becomes available Annotations @Override Exceptions InterruptedException: If the wait is interrupted

remove

back to summary

public Reference<? extends T> remove() throws InterruptedException

Overrides java.lang.ref.ReferenceQueue.remove.

Doc from java.lang.ref.ReferenceQueue.remove.

Removes the next reference object in this queue, blocking until one becomes available.

Returns:Reference<? extends T>

A reference object, blocking until one becomes available

Annotations