Package org.miaixz.bus.core.io.watch

Class WatchServiceWrapper

java.lang.Object

org.miaixz.bus.core.io.watch.WatchServiceWrapper

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, WatchService, Wrapper<WatchService>, Provider

public class WatchServiceWrapper
extends Object
implements WatchService, Wrapper<WatchService>, Serializable

WatchEvent 包装类，提供可选的监听事件和监听选项，实现方法包括：

• 注册：registerPath(Path, int)注册需要监听的路径。
• 监听：watch(Watcher, Predicate) 启动监听并指定事件触发后的行为。

Since:

Java 17+

Author:

Kimi Liu

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WatchServiceWrapper(WatchEvent.Kind<?>... events)	构造

Method Summary

Modifier and Type	Method	Description
void	close()
WatchService	getRaw()	获取原始对象
boolean	isClosed()	是否已关闭
static WatchServiceWrapper	of(WatchEvent.Kind<?>... events)	创建WatchServiceWrapper
WatchKey	poll()
WatchKey	poll(long timeout, TimeUnit unit)
WatchKey	register(Watchable watchable)	注册单一的监听
WatchServiceWrapper	registerPath(Path path, int maxDepth)	递归将指定路径加入到监听中 如果提供的是目录，则监听目录本身和目录下的目录和文件，深度取决于maxDepth
WatchServiceWrapper	setEvents(WatchEvent.Kind<?>... events)	监听事件列表，见：StandardWatchEventKinds
WatchServiceWrapper	setEvents(WatchKind... kinds)	监听事件列表，见：StandardWatchEventKinds
WatchServiceWrapper	setModifiers(WatchEvent.Modifier... modifiers)	设置监听选项，例如监听频率等，可设置项包括：
WatchKey	take()
void	watch(BiConsumer<WatchEvent<?>,WatchKey> action)	执行事件获取并处理 WatchEvent.context()是实际操作的文件或目录的相对监听路径的Path，非绝对路径 WatchKey.watchable()是监听的Path 此方法调用后阻塞线程，直到触发监听事件，执行后退出，无循环执行操作
void	watch(BiConsumer<WatchEvent<?>,WatchKey> action, Predicate<WatchEvent<?>> watchFilter)	执行事件获取并处理 WatchEvent.context()是实际操作的文件或目录的相对监听路径的Path，非绝对路径 WatchKey.watchable()是监听的Path 此方法调用后阻塞线程，直到触发监听事件，执行后退出，无循环执行操作
void	watch(Watcher watcher, Predicate<WatchEvent<?>> watchFilter)	执行事件获取并处理 WatchEvent.context()是实际操作的文件或目录的相对监听路径的Path，非绝对路径 WatchKey.watchable()是监听的Path 此方法调用后阻塞线程，直到触发监听事件，执行后退出，无循环执行操作

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.miaixz.bus.core.lang.Wrapper

type

Constructor Details

WatchServiceWrapper

public WatchServiceWrapper(WatchEvent.Kind<?>... events)

构造

Parameters:

events - 监听事件列表

Method Details

of

public static WatchServiceWrapper of(WatchEvent.Kind<?>... events)

创建WatchServiceWrapper

Parameters:

events - 监听事件列表，如新建、修改、删除等

Returns:

WatchServiceWrapper

getRaw

public WatchService getRaw()

Description copied from interface: Wrapper

获取原始对象

Specified by:

getRaw in interface Wrapper<WatchService>

Returns:

原始对象

isClosed

public boolean isClosed()

是否已关闭

Returns:

是否已关闭

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface WatchService

poll

public WatchKey poll()

Specified by:

poll in interface WatchService

poll

public WatchKey poll(long timeout,
 TimeUnit unit)
              throws InterruptedException

Specified by:

poll in interface WatchService

Throws:

InterruptedException

take

public WatchKey take()
              throws InterruptedException

Specified by:

take in interface WatchService

Throws:

InterruptedException

setEvents

public WatchServiceWrapper setEvents(WatchKind... kinds)

监听事件列表，见：StandardWatchEventKinds

Parameters:

kinds - 事件列表

Returns:

this

setEvents

public WatchServiceWrapper setEvents(WatchEvent.Kind<?>... events)

监听事件列表，见：StandardWatchEventKinds

Parameters:

events - 事件列表

Returns:

this

setModifiers

public WatchServiceWrapper setModifiers(WatchEvent.Modifier... modifiers)

设置监听选项，例如监听频率等，可设置项包括：

 1、com.sun.nio.file.StandardWatchEventKinds
 2、com.sun.nio.file.SensitivityWatchEventModifier
 

Parameters:

modifiers - 监听选项，例如监听频率等

Returns:

this

register

public WatchKey register(Watchable watchable)

注册单一的监听

Parameters:

watchable - 可注册对象，如Path

Returns:

WatchKey，如果为null，表示注册失败

See Also:

• Watchable.register(WatchService, WatchEvent.Kind[])
• Watchable.register(WatchService, WatchEvent.Kind[], WatchEvent.Modifier...)

registerPath

public WatchServiceWrapper registerPath(Path path,
 int maxDepth)

递归将指定路径加入到监听中 如果提供的是目录，则监听目录本身和目录下的目录和文件，深度取决于maxDepth

Parameters:

path - 路径

maxDepth - 递归下层目录的最大深度

Returns:

this

watch

public void watch(Watcher watcher,
 Predicate<WatchEvent<?>> watchFilter)

执行事件获取并处理 WatchEvent.context()是实际操作的文件或目录的相对监听路径的Path，非绝对路径 WatchKey.watchable()是监听的Path 此方法调用后阻塞线程，直到触发监听事件，执行后退出，无循环执行操作

Parameters:

watcher - Watcher

watchFilter - 监听过滤接口，通过实现此接口过滤掉不需要监听的情况，Predicate.test(Object)为true保留，null表示不过滤

watch

public void watch(BiConsumer<WatchEvent<?>,WatchKey> action)

执行事件获取并处理 WatchEvent.context()是实际操作的文件或目录的相对监听路径的Path，非绝对路径 WatchKey.watchable()是监听的Path 此方法调用后阻塞线程，直到触发监听事件，执行后退出，无循环执行操作

Parameters:

action - 监听回调函数，实现此函数接口用于处理WatchEvent事件

watch

public void watch(BiConsumer<WatchEvent<?>,WatchKey> action,
 Predicate<WatchEvent<?>> watchFilter)

执行事件获取并处理 WatchEvent.context()是实际操作的文件或目录的相对监听路径的Path，非绝对路径 WatchKey.watchable()是监听的Path 此方法调用后阻塞线程，直到触发监听事件，执行后退出，无循环执行操作

Parameters:

action - 监听回调函数，实现此函数接口用于处理WatchEvent事件

watchFilter - 监听过滤接口，通过实现此接口过滤掉不需要监听的情况，Predicate.test(Object)为true保留，null表示不过滤