Интерфейс WatchKey

public interface WatchKey

Токен, представляющий регистрацию объекта watchable в службе наблюдения WatchService.

Ключ наблюдения создается, когда объект наблюдения регистрируется в службе наблюдения. Ключ остается valid до тех пор:

1. Он отменяется явно, вызывая его метод cancel, или
2. Отменяется неявно, потому что объект больше недоступен, или
3. Служба наблюдения закрывается, вызывая метод closing.

Ключ наблюдения имеет состояние. При первоначальном создании ключ считается готовым. Когда обнаруживается событие, ключ переходит в состояние сигнализации и помещается в очередь, чтобы его можно было получить, вызвав методы службы наблюдения poll или take. После сигнализации ключ остается в этом состоянии до тех пор, пока не будет вызван метод reset для возвращения ключа в состояние готовности. События, обнаруженные, когда ключ находится в состоянии сигнализации, помещаются в очередь, но не приводят к повторному размещению ключа в очередь для извлечения из службы наблюдения. События извлекаются путем вызова метода ключа pollEvents. Этот метод извлекает и удаляет все накопленные события для объекта. При первоначальном создании ключ наблюдения не имеет ожидающих событий. Как правило, события извлекаются, когда ключ находится в состоянии сигнализации, что приводит к следующему выражению:

for (;;) {
         // retrieve key
         WatchKey key = watcher.take();

         // process events
         for (WatchEvent<?> event: key.pollEvents()) {
             :
         }

         // reset the key
         boolean valid = key.reset();
         if (!valid) {
             // object no longer registered
         }
     }

Ключи наблюдения безопасны для использования несколькими конкурирующими потоками. В случае нескольких потоков, извлекающих сигнализируемые ключи из службы наблюдения, следует позаботиться о том, чтобы метод reset вызывался только после обработки событий для объекта. Это гарантирует, что в любой момент времени один поток обрабатывает события для объекта.

Методы

isValid

boolean isValid()

Возвращает:

true если и только если этот ключ наблюдения действителен

pollEvents

List<WatchEvent<?>> pollEvents()

Возвращает:

список извлеченных событий; может быть пустым

reset

boolean reset()

Возвращает:

true если ключ наблюдения действителен и был сброшен, и false если ключ наблюдения не может быть сброшен, потому что он больше не valid

cancel

void cancel()

watchable

Watchable watchable()

Возвращает:

объект, для которого был создан этот ключ наблюдения