java.nio.file

Интерфейсный WatchKey

public interface WatchKey

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

С тех пор:

1.7

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
void	cancel() Отменяет регистрацию со службой часов.
boolean	isValid() Говорит, допустим ли этот ключ часов.
List<WatchEvent<?>>	pollEvents() Получает и удаляет все события на ожидании для этого ключа часов, возвращаясь a List из событий, которые были получены.
boolean	reset() Сбросы этот ключ часов.
Смотрибельный	watchable() Возвращает объект, для которого создавался этот ключ часов.

Деталь метода

isValid

boolean isValid()

Говорит, допустим ли этот ключ часов.

Ключ часов допустим после создания и остается, пока это не отменяется, или его служба часов закрывается.

Возвраты:

true если, и только если, этот ключ часов допустим

pollEvents

List<WatchEvent<?>> pollEvents()

Получает и удаляет все события на ожидании для этого ключа часов, возвращаясь a List из событий, которые были получены.

Отметьте, что этот метод не ожидает, если нет никакого ожидания событий.

Возвраты:

список событий получается; может быть пустым

сброс

boolean reset()

Сбросы этот ключ часов.

Если этот ключ часов был отменен, или этот ключ часов уже находится в состоянии готовности, тогда вызывающем этот метод, не имеет никакого эффекта. Иначе, если там ожидают события для объекта тогда, этот ключ часов был сразу повторно поставлен в очередь к службе часов. Если нет никаких событий на ожидании тогда, ключ часов помещается в состояние готовности и останется в том состоянии, пока событие не обнаруживается, или ключ часов отменяется.

Возвраты:

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

отмена

void cancel()

Отменяет регистрацию со службой часов. По возврату ключ часов будет недопустим. Если ключ часов будет ставиться в очередь, ожидая, чтобы быть полученным от службы часов, то это останется в очереди, пока это не будет удалено. События на ожидании, если таковые вообще имеются, остаются ожидать и могут быть получены, вызывая pollEvents метод после ключа отменяется.

Если этот ключ часов был уже отменен, затем вызывая этот метод, не имеет никакого эффекта. После того, как отмененный, ключ часов остается навсегда недопустимым.

смотрибельный

Watchable watchable()

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

Как WatchService предназначается, чтобы отобразить непосредственно на собственном средстве уведомления о событии файла (где доступный) тогда многие из деталей о том, как зарегистрированные объекты наблюдаются, чрезвычайно определенная реализация. Наблюдая каталог за изменениями например, и каталог перемещается или переименовывается в файловой системе, нет никакой гарантии, что ключ часов будет отменен и таким образом, объект, возвращенный этим методом, больше, возможно, не будет допустимым путем к каталогу.

Возвраты:

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