Интерфейс WatchKey

Ключ наблюдения создается при регистрации объекта watchable в службе наблюдения. Ключ остается 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 вызывался только после обработки событий для объекта. Это гарантирует, что один поток обрабатывает события для объекта в любой момент времени.