Spec-Zone.ru › OpenJDK 21

Интерфейс WatchKey

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

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

С:
1.7

Краткое описание методов

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

Подробное описание методов

isValid

boolean isValid()
Указывает, является ли этот ключ наблюдения действительным.

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

Возвращает:
true если, и только если, этот ключ наблюдения действителен

pollEvents

List<WatchEvent<?>> pollEvents()
Извлекает и удаляет все ожидающие события для этого ключа наблюдения, возвращая List событий, которые были извлечены.

Обратите внимание, что этот метод не ожидает, если ожидающие события отсутствуют.

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

reset

boolean reset()
Сбрасывает этот ключ наблюдения.

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

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

cancel

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

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

watchable

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

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

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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/WatchKey.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API