com.barbarysoftware.watchservice

Class WatchService

java.lang.Object

com.barbarysoftware.watchservice.WatchService

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class WatchService
extends Object
implements Closeable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WatchService()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Closes this watch service.
static WatchService	newWatchService()
abstract WatchKey	poll() Retrieves and removes the next watch key, or null if none are present.
abstract WatchKey	poll(long timeout, TimeUnit unit) Retrieves and removes the next watch key, waiting if necessary up to the specified wait time if none are yet present.
abstract WatchKey	take() Retrieves and removes next watch key, waiting if none are yet present.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WatchService

protected WatchService()

Method Detail

close

public abstract void close()
                    throws IOException

Closes this watch service. <p/> <p> 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. <p/> <p> 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.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs

poll

public abstract WatchKey poll()

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

Returns:

the next watch key, or null

Throws:

ClosedWatchServiceException - if this watch service is closed

poll

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

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

Parameters:

timeout - how to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the next watch key, or null

Throws:

ClosedWatchServiceException - if this watch service is closed, or it is closed while waiting for the next key

InterruptedException - if interrupted while waiting

take

public abstract WatchKey take()
                       throws InterruptedException

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

Returns:

the next watch key

Throws:

ClosedWatchServiceException - if this watch service is closed, or it is closed while waiting for the next key

InterruptedException - if interrupted while waiting

newWatchService

public static WatchService newWatchService()