-
- All Known Subinterfaces:
- Path
public interface Watchable
An object that may be registered with a watch service so that it can be watched for changes and events.This interface defines the
register
method to register the object with aWatchService
returning aWatchKey
to represent the registration. An object may be registered with more than one watch service. Registration with a watch service is cancelled by invoking the key'scancel
method.
-
-
Method Summary
Methods Modifier and Type Method and Description 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.
-
-
-
Method Detail
-
register
WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) throws IOException
Registers an object with a watch service.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
andmodifiers
parameters. Changing the event set does not cause pending events for the object to be discarded. Objects are automatically registered for theOVERFLOW
event. This event is not required to be present in the array of events.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.
Implementations of this interface should specify the events they support.
- Parameters:
watcher
- the watch service to which this object is to be registeredevents
- the events for which this object should be registeredmodifiers
- 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:
UnsupportedOperationException
- if unsupported events or modifiers are specifiedIllegalArgumentException
- if an invalid of combination of events are modifiers are specifiedClosedWatchServiceException
- if the watch service is closedIOException
- if an I/O error occursSecurityException
- if a security manager is installed and it denies an unspecified permission required to monitor this object. Implementations of this interface should specify the permission checks.
-
register
WatchKey register(WatchService watcher, WatchEvent.Kind<?>... events) throws IOException
Registers an object with a watch service.An invocation of this method behaves in exactly the same way as the invocation
watchable.
register
(watcher, events, new WatchEvent.Modifier[0]);- Parameters:
watcher
- the watch service to which this object is to be registeredevents
- the events for which this object should be registered- Returns:
- a key representing the registration of this object with the given watch service
- Throws:
UnsupportedOperationException
- if unsupported events are specifiedIllegalArgumentException
- if an invalid of combination of events are specifiedClosedWatchServiceException
- if the watch service is closedIOException
- if an I/O error occursSecurityException
- if a security manager is installed and it denies an unspecified permission required to monitor this object. Implementations of this interface should specify the permission checks.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/nio/file/Watchable.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.