Package name.pachler.nio.file
Interface Watchable
public interface Watchable
A watchable is an object that can be registered with a
WatchService
to be monitored for changes via it's register
methods.
The watchable only defines an interface, use Path
to actually
watch directories.-
Method Summary
Modifier and TypeMethodDescriptionregister
(WatchService watcher, WatchEvent.Kind<?>... events) Registers the file system path (a directory) with the given WatchService and provides a WatchKey as a handle for that registration.register
(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) Registers the file system path (a directory) with the givenWatchService
and provides a WatchKey as a handle for that registration.
-
Method Details
-
register
Registers the file system path (a directory) with the given WatchService and provides a WatchKey as a handle for that registration. Equivalent to callingregister(watcher, events, new WatchEvent.Modifier[0]);
- Throws:
IOException
- See Also:
-
register
WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) throws IOException Registers the file system path (a directory) with the givenWatchService
and provides a WatchKey as a handle for that registration. The events and modifier lists determine the events that theWatchService
will report.
If a path instance is passed in that represents the same file system object that has been specified in a previous call to this method with the sameWatchService
, the sameWatchKey
will be returned. In this case, theWatchKey
's watch settings are altered to match the new event and modifier lists. Note that such changes may result inStandardWatchEventKind.OVERFLOW
events to be reported on some platforms.
Not all event kinds and modifiers defined inStandardWatchEventKind
,ExtendedWatchEventKind
andExtendedWatchEventModifier
may be supported on a target platform (typically though, in this implementation, all event kinds defined inStandardWatchEventKind
are always supported).- Parameters:
watcher
- a validWatchService
instance.events
- The events to register for. The event kinds defined inStandardWatchEventKind
andExtendedWatchEventKind
define valid event kinds that can be passed in here. Not that not all event kinds may be supported on a given platform, so see the documentation of a specific event kind.modifiers
- The event modifiers to use when registering.invalid reference
WatchEvent$Modifier
WatchService
. Note that some event modifiers may not be supported on a given platform; see the specific modifier for details.- Returns:
- a new
WatchKey
that represents the registration. - See Also:
-