Interface WatchEvent<T>
-
- Type Parameters:
-
T
- The type of the context object associated with the event
public interface WatchEvent<T>
An event or a repeated event for an object that is registered with aWatchService
.An event is classified by its
kind
and has acount
to indicate the number of times that the event has been observed. This allows for efficient representation of repeated events. Thecontext
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.
- Since:
- 1.7
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static interface
WatchEvent.Kind<T>
An event kind, for the purposes of identification.static interface
WatchEvent.Modifier
An event modifier that qualifies how aWatchable
is registered with aWatchService
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description T
context()
Returns the context for the event.int
count()
Returns the event count.WatchEvent.Kind<T>
kind()
Returns the event kind.
-
-
-
Method Detail
kind
WatchEvent.Kind<T> kind()
Returns the event kind.- Returns:
- the event kind
count
int count()
Returns the event count. If the event count is greater than1
then this is a repeated event.- Returns:
- the event count
context
T context()
Returns the context for the event.In the case of
ENTRY_CREATE
,ENTRY_DELETE
, andENTRY_MODIFY
events the context is aPath
that is therelative
path between the directory registered with the watch service, and the entry that is created, deleted, or modified.- Returns:
-
the event context; may be
null
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.