com.barbarysoftware.watchservice

Class WatchEvent<T>

java.lang.Object

com.barbarysoftware.watchservice.WatchEvent<T>

public abstract class WatchEvent<T>
extends Object

An event or a repeated event for an object that is registered with a WatchService.

<p> 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.

<p> Watch events are immutable and safe for use by multiple concurrent threads.

Since:

1.7

Nested Class Summary

Nested Classes

Modifier and Type	Class 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 a Watchable is registered with a WatchService.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WatchEvent() Initializes a new instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WatchEvent

protected WatchEvent()

Initializes a new instance of this class.

Method Detail

kind

public abstract WatchEvent.Kind<T> kind()

Returns the event kind.

Returns:

the event kind

count

public abstract int count()

Returns the event count. If the event count is greater than 1 then this is a repeated event.

Returns:

the event count

context

public abstract T context()

Returns the context for the event.

<p> In the case of ENTRY_CREATE, ENTRY_DELETE, and ENTRY_MODIFY events the context is a File.

Returns:

the event context; may be null