com.barbarysoftware.watchservice

Class WatchableFile

java.lang.Object

com.barbarysoftware.watchservice.WatchableFile

All Implemented Interfaces:

Watchable

public class WatchableFile
extends Object
implements Watchable

Constructor Summary

Constructors

Constructor and Description
WatchableFile(File file)

Method Summary

Methods

Modifier and Type	Method and Description
File	getFile()
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>... events) Registers an object with a watch service.
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) Registers an object with a watch service.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WatchableFile

public WatchableFile(File file)

Method Detail

getFile

public File getFile()

register

public WatchKey register(WatchService watcher,
                WatchEvent.Kind<?>[] events,
                WatchEvent.Modifier... modifiers)
                  throws IOException

Description copied from interface: Watchable

Registers an object with a watch service.

<p> If the file system object identified by this object is currently registered with the watch service then the watch key, representing that registration, is returned after changing the event set or modifiers to those specified by the events and modifiers parameters. Changing the event set does not cause pending events for the object to be discarded. Objects are automatically registered for the OVERFLOW event. This event is not required to be present in the array of events.

<p> Otherwise the file system object has not yet been registered with the given watch service, so it is registered and the resulting new key is returned.

<p> Implementations of this interface should specify the events they support.

Specified by:

register in interface Watchable

Parameters:

watcher - the watch service to which this object is to be registered

events - the events for which this object should be registered

modifiers - the modifiers, if any, that modify how the object is registered

Returns:

a key representing the registration of this object with the given watch service

Throws:

IOException - if an I/O error occurs

register

public final WatchKey register(WatchService watcher,
                WatchEvent.Kind<?>... events)
                        throws IOException

Description copied from interface: Watchable

Registers an object with a watch service.

<p> An invocation of this method behaves in exactly the same way as the invocation <pre> watchable.#register(WatchService, com.barbarysoftware.watchservice.WatchEvent.Kind[], com.barbarysoftware.watchservice.WatchEvent.Modifier…) register}(watcher, events, new WatchEvent.Modifier[0]); </pre>

Specified by:

register in interface Watchable

Parameters:

watcher - the watch service to which this object is to be registered

events - the events for which this object should be registered

Returns:

a key representing the registration of this object with the given watch service

Throws:

IOException - if an I/O error occurs

toString

public String toString()

Overrides:

toString in class Object