cn.hutool.core.io.watch

Class WatchServer

java.lang.Object

java.lang.Thread

cn.hutool.core.io.watch.WatchServer

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Runnable

Direct Known Subclasses:

WatchMonitor

public class WatchServer
extends Thread
implements Closeable, Serializable

文件监听服务，此服务可以同时监听多个路径。

Since:

5.1.0

Author:

loolly

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected WatchEvent.Kind<?>[]	events 监听事件列表
protected boolean	isClosed 监听是否已经关闭

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
WatchServer()

Method Summary

Modifier and Type	Method and Description
void	close() 关闭监听
WatchKey	getWatchKey(Path path) 通过 path 获取 watchKey
void	init() 初始化 初始化包括： 1、解析传入的路径，判断其为目录还是文件 2、创建WatchService 对象
void	registerPath(Path path, int maxDepth) 将指定路径加入到监听中
void	setModifiers(WatchEvent.Modifier[] modifiers) 设置监听选项，例如监听频率等，可设置项包括： 1、com.sun.nio.file.StandardWatchEventKinds 2、com.sun.nio.file.SensitivityWatchEventModifier
void	watch(WatchAction action, Filter<WatchEvent<?>> watchFilter) 执行事件获取并处理
void	watch(Watcher watcher, Filter<WatchEvent<?>> watchFilter) 执行事件获取并处理

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

events

protected WatchEvent.Kind<?>[] events

监听事件列表

isClosed

protected boolean isClosed

监听是否已经关闭

Constructor Detail

WatchServer

public WatchServer()

Method Detail

init

public void init()
          throws WatchException

初始化
初始化包括：

 1、解析传入的路径，判断其为目录还是文件
 2、创建WatchService 对象
 

Throws:

WatchException - 监听异常，IO异常时抛出此异常

setModifiers

public void setModifiers(WatchEvent.Modifier[] modifiers)

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

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

Parameters:

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

registerPath

public void registerPath(Path path,
                         int maxDepth)

将指定路径加入到监听中

Parameters:

path - 路径

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

watch

public void watch(WatchAction action,
                  Filter<WatchEvent<?>> watchFilter)

执行事件获取并处理

Parameters:

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

watchFilter - 监听过滤接口，通过实现此接口过滤掉不需要监听的情况，null表示不过滤

Since:

5.4.0

watch

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

执行事件获取并处理

Parameters:

watcher - Watcher

watchFilter - 监听过滤接口，通过实现此接口过滤掉不需要监听的情况，null表示不过滤

getWatchKey

public WatchKey getWatchKey(Path path)

通过 path 获取 watchKey

Parameters:

path - path

Returns:

如果不存在则返回 null

close

public void close()

关闭监听

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable