OpenJDK 27 · sun.nio.fs.AbstractWatchService · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final WatchKey	CLOSE_KEY
private volatile boolean	closed
private final Object	closeLock
private final LinkedBlockingDeque<WatchKey>	pendingKeys

Access	Constructor and Description
protected	AbstractWatchService()

Method Summary

Modifier and Type	Method and Description
private void	checkKey(WatchKey key) Checks the key isn't the special CLOSE_KEY used to unblock threads when the watch service is closed.
private void	checkOpen() Throws ClosedWatchServiceException if watch service is closed
public final void	close() Implements java.nio.file.WatchService.close. Closes this watch service.
pack-priv final Object	closeLock() Retrieves the object upon which the close method synchronizes.
pack-priv final void	enqueueKey(WatchKey key)
pack-priv abstract void	implClose() Closes this watch service.
pack-priv final boolean	isOpen() Tells whether or not this watch service is open.
public final WatchKey	poll() Implements java.nio.file.WatchService.poll. Retrieves and removes the next watch key, or `null` if none are present.
public final WatchKey	poll(long timeout, TimeUnit unit) Implements java.nio.file.WatchService.poll. Retrieves and removes the next watch key, waiting if necessary up to the specified wait time if none are yet present.
pack-priv abstract WatchKey	register(Path path, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) Register the given object with this watch service
public final WatchKey	take() Implements java.nio.file.WatchService.take. Retrieves and removes next watch key, waiting if none are yet present.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CLOSE_KEY	back to summary
private final WatchKey CLOSE_KEY

closed	back to summary
private volatile boolean closed

closeLock	back to summary
private final Object closeLock

pendingKeys	back to summary
private final LinkedBlockingDeque<WatchKey> pendingKeys

AbstractWatchService	back to summary
protected AbstractWatchService()

Method Detail

checkKey	back to summary
private void checkKey(WatchKey key) Checks the key isn't the special CLOSE_KEY used to unblock threads when the watch service is closed.

checkOpen	back to summary
private void checkOpen() Throws ClosedWatchServiceException if watch service is closed

close back to summary

close	back to summary
public final void close() throws IOException Implements java.nio.file.WatchService.close. Doc from java.nio.file.WatchService.close. Closes this watch service. If a thread is currently blocked in the `take` or `poll` methods waiting for a key to be queued then it immediately receives a `ClosedWatchServiceException`. Any valid keys associated with this watch service are `invalidated`. After a watch service is closed, any further attempt to invoke operations upon it will throw `ClosedWatchServiceException`. If this watch service is already closed then invoking this method has no effect. Annotations @Override Exceptions IOException: if an I/O error occurs

public final void close() throws IOException

Implements java.nio.file.WatchService.close.

Doc from java.nio.file.WatchService.close.

Closes this watch service.

If a thread is currently blocked in the take or poll methods waiting for a key to be queued then it immediately receives a ClosedWatchServiceException. Any valid keys associated with this watch service are invalidated.

After a watch service is closed, any further attempt to invoke operations upon it will throw ClosedWatchServiceException. If this watch service is already closed then invoking this method has no effect.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

closeLock	back to summary
pack-priv final Object closeLock() Retrieves the object upon which the close method synchronizes.

enqueueKey	back to summary
pack-priv final void enqueueKey(WatchKey key)

implClose	back to summary
pack-priv abstract void implClose() throws IOException Closes this watch service. This method is invoked by the close method to perform the actual work of closing the watch service.

isOpen	back to summary
pack-priv final boolean isOpen() Tells whether or not this watch service is open.

poll back to summary

poll	back to summary
public final WatchKey poll() Implements java.nio.file.WatchService.poll. Doc from java.nio.file.WatchService.poll. Retrieves and removes the next watch key, or `null` if none are present. Annotations @Override

public final WatchKey poll()

Implements java.nio.file.WatchService.poll.

Doc from java.nio.file.WatchService.poll.

Retrieves and removes the next watch key, or null if none are present.

Annotations

@Override

poll	back to summary
public final WatchKey poll(long timeout, TimeUnit unit) throws InterruptedException Implements java.nio.file.WatchService.poll. Doc from java.nio.file.WatchService.poll. Retrieves and removes the next watch key, waiting if necessary up to the specified wait time if none are yet present. Annotations @Override Exceptions InterruptedException: if interrupted while waiting

poll

back to summary

public final WatchKey poll(long timeout, TimeUnit unit) throws InterruptedException

Implements java.nio.file.WatchService.poll.

Doc from java.nio.file.WatchService.poll.

Retrieves and removes the next watch key, waiting if necessary up to the specified wait time if none are yet present.

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting

register	back to summary
pack-priv abstract WatchKey register(Path path, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) throws IOException Register the given object with this watch service

take	back to summary
public final WatchKey take() throws InterruptedException Implements java.nio.file.WatchService.take. Doc from java.nio.file.WatchService.take. Retrieves and removes next watch key, waiting if none are yet present. Annotations @Override Exceptions InterruptedException: if interrupted while waiting

take

back to summary

public final WatchKey take() throws InterruptedException

Implements java.nio.file.WatchService.take.

Doc from java.nio.file.WatchService.take.

Retrieves and removes next watch key, waiting if none are yet present.

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting

pack-priv abstract Class AbstractWatchService

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail