WatchEvent
interface WatchEvent<T : Any!>
java.nio.file.WatchEvent |
An event or a repeated event for an object that is registered with a WatchService
.
An event is classified by its kind
and has a count
to indicate the number of times that the event has been observed. This allows for efficient representation of repeated events. The context
method returns any context associated with the event. In the case of a repeated event then the context is the same for all events.
Watch events are immutable and safe for use by multiple concurrent threads.
Summary
Nested classes | |
---|---|
abstract |
An event kind, for the purposes of identification. |
abstract |
An event modifier that qualifies how a |
Public methods | |
---|---|
abstract T |
context() Returns the context for the event. |
abstract Int |
count() Returns the event count. |
abstract WatchEvent.Kind<T>! |
kind() Returns the event kind. |
Public methods
context
abstract fun context(): T
Returns the context for the event.
In the case of ENTRY_CREATE
, ENTRY_DELETE
, and ENTRY_MODIFY
events the context is a Path
that is the relative
path between the directory registered with the watch service, and the entry that is created, deleted, or modified.
Return | |
---|---|
T |
the event context; may be null |
count
abstract fun count(): Int
Returns the event count. If the event count is greater than 1
then this is a repeated event.
Return | |
---|---|
Int |
the event count |
kind
abstract fun kind(): WatchEvent.Kind<T>!
Returns the event kind.
Return | |
---|---|
WatchEvent.Kind<T>! |
the event kind |