cn.hutool.core.io.watch

类 WatchMonitor

java.lang.Object

java.lang.Thread

cn.hutool.core.io.watch.WatchMonitor

所有已实现的接口:

Closeable, AutoCloseable, Runnable

public class WatchMonitor
extends Thread
implements Closeable

路径监听器
监听器可监听目录或文件
如果监听的Path不存在，则递归创建空目录然后监听此空目录
递归监听目录时，并不会监听新创建的目录

作者:

Looly

嵌套类概要

从类继承的嵌套类/接口 java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

字段概要

字段

限定符和类型	字段和说明
static WatchEvent.Kind<?>	ENTRY_CREATE 创建事件
static WatchEvent.Kind<?>	ENTRY_DELETE 删除事件
static WatchEvent.Kind<?>	ENTRY_MODIFY 修改事件
static WatchEvent.Kind<?>[]	EVENTS_ALL 全部事件
static WatchEvent.Kind<?>	OVERFLOW 事件丢失

从类继承的字段 java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

构造器概要

构造器

构造器和说明
WatchMonitor(File file, WatchEvent.Kind<?>... events) 构造
WatchMonitor(Path path, int maxDepth, WatchEvent.Kind<?>... events) 构造 例如设置： maxDepth <= 1 表示只监听当前目录 maxDepth = 2 表示监听当前目录以及下层目录 maxDepth = 3 表示监听当前目录以及下层
WatchMonitor(Path path, WatchEvent.Kind<?>... events) 构造
WatchMonitor(String path, WatchEvent.Kind<?>... events) 构造

方法概要

方法

限定符和类型	方法和说明
void	close() 关闭监听
static WatchMonitor	create(File file, int maxDepth, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(File file, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(Path path, int maxDepth, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(Path path, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(String path, int maxDepth, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(String path, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(URI uri, int maxDepth, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(URI uri, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(URL url, int maxDepth, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	create(URL url, WatchEvent.Kind<?>... events) 创建并初始化监听
static WatchMonitor	createAll(File file, Watcher watcher) 创建并初始化监听，监听所有事件
static WatchMonitor	createAll(Path path, Watcher watcher) 创建并初始化监听，监听所有事件
static WatchMonitor	createAll(String path, Watcher watcher) 创建并初始化监听，监听所有事件
static WatchMonitor	createAll(URI uri, Watcher watcher) 创建并初始化监听，监听所有事件
static WatchMonitor	createAll(URL url, Watcher watcher) 创建并初始化监听，监听所有事件
void	init() 初始化 初始化包括： 1、解析传入的路径，判断其为目录还是文件 2、创建WatchService 对象
void	run()
WatchMonitor	setMaxDepth(int maxDepth) 当监听目录时，监听目录的最大深度 当设置值为1（或小于1）时，表示不递归监听子目录 例如设置： maxDepth <= 1 表示只监听当前目录 maxDepth = 2 表示监听当前目录以及下层目录 maxDepth = 3 表示监听当前目录以及下层
WatchMonitor	setWatcher(Watcher watcher) 设置监听 多个监听请使用WatcherChain
void	watch() 开始监听事件，阻塞当前进程
void	watch(Watcher watcher) 开始监听事件，阻塞当前进程

从类继承的方法 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, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

从类继承的方法 java.lang.Object

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

字段详细资料

OVERFLOW

public static final WatchEvent.Kind<?> OVERFLOW

事件丢失

ENTRY_MODIFY

public static final WatchEvent.Kind<?> ENTRY_MODIFY

修改事件

ENTRY_CREATE

public static final WatchEvent.Kind<?> ENTRY_CREATE

创建事件

ENTRY_DELETE

public static final WatchEvent.Kind<?> ENTRY_DELETE

删除事件

EVENTS_ALL

public static final WatchEvent.Kind<?>[] EVENTS_ALL

全部事件

构造器详细资料

WatchMonitor

public WatchMonitor(File file,
            WatchEvent.Kind<?>... events)

构造

参数:

file - 文件

events - 监听的事件列表

WatchMonitor

public WatchMonitor(String path,
            WatchEvent.Kind<?>... events)

构造

参数:

path - 字符串路径

events - 监听的事件列表

WatchMonitor

public WatchMonitor(Path path,
            WatchEvent.Kind<?>... events)

构造

参数:

path - 字符串路径

events - 监听事件列表

WatchMonitor

public WatchMonitor(Path path,
            int maxDepth,
            WatchEvent.Kind<?>... events)

构造
例如设置：

 maxDepth <= 1 表示只监听当前目录
 maxDepth = 2 表示监听当前目录以及下层目录
 maxDepth = 3 表示监听当前目录以及下层
 

参数:

path - 字符串路径

maxDepth - 递归目录的最大深度，当小于2时不递归下层目录

events - 监听事件列表

方法详细资料

create

public static WatchMonitor create(URL url,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

url - URL

events - 监听的事件列表

返回:

监听对象

create

public static WatchMonitor create(URL url,
                  int maxDepth,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

url - URL

events - 监听的事件列表

maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录

返回:

监听对象

create

public static WatchMonitor create(URI uri,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

uri - URI

events - 监听的事件列表

返回:

监听对象

create

public static WatchMonitor create(URI uri,
                  int maxDepth,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

uri - URI

events - 监听的事件列表

maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录

返回:

监听对象

create

public static WatchMonitor create(File file,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

file - 文件

events - 监听的事件列表

返回:

监听对象

create

public static WatchMonitor create(File file,
                  int maxDepth,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

file - 文件

events - 监听的事件列表

maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录

返回:

监听对象

create

public static WatchMonitor create(String path,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

path - 路径

events - 监听的事件列表

返回:

监听对象

create

public static WatchMonitor create(String path,
                  int maxDepth,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

path - 路径

events - 监听的事件列表

maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录

返回:

监听对象

create

public static WatchMonitor create(Path path,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

path - 路径

events - 监听事件列表

返回:

监听对象

create

public static WatchMonitor create(Path path,
                  int maxDepth,
                  WatchEvent.Kind<?>... events)

创建并初始化监听

参数:

path - 路径

events - 监听事件列表

maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录

返回:

监听对象

createAll

public static WatchMonitor createAll(URI uri,
                     Watcher watcher)

创建并初始化监听，监听所有事件

参数:

uri - URI

watcher - Watcher

返回:

WatchMonitor

createAll

public static WatchMonitor createAll(URL url,
                     Watcher watcher)

创建并初始化监听，监听所有事件

参数:

url - URL

watcher - Watcher

返回:

WatchMonitor

createAll

public static WatchMonitor createAll(File file,
                     Watcher watcher)

创建并初始化监听，监听所有事件

参数:

file - 被监听文件

watcher - Watcher

返回:

WatchMonitor

createAll

public static WatchMonitor createAll(String path,
                     Watcher watcher)

创建并初始化监听，监听所有事件

参数:

path - 路径

watcher - Watcher

返回:

WatchMonitor

createAll

public static WatchMonitor createAll(Path path,
                     Watcher watcher)

创建并初始化监听，监听所有事件

参数:

path - 路径

watcher - Watcher

返回:

WatchMonitor

init

public void init()
          throws WatchException

初始化
初始化包括：

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

抛出:

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

setWatcher

public WatchMonitor setWatcher(Watcher watcher)

设置监听
多个监听请使用WatcherChain

参数:

watcher - 监听

返回:

WatchMonitor

run

public void run()

指定者:

run 在接口中 Runnable

覆盖:

run 在类中 Thread

watch

public void watch()

开始监听事件，阻塞当前进程

watch

public void watch(Watcher watcher)
           throws WatchException

开始监听事件，阻塞当前进程

参数:

watcher - 监听

抛出:

WatchException - 监听异常，如果监听关闭抛出此异常

setMaxDepth

public WatchMonitor setMaxDepth(int maxDepth)

当监听目录时，监听目录的最大深度
当设置值为1（或小于1）时，表示不递归监听子目录
例如设置：

 maxDepth <= 1 表示只监听当前目录
 maxDepth = 2 表示监听当前目录以及下层目录
 maxDepth = 3 表示监听当前目录以及下层
 

参数:

maxDepth - 最大深度，当设置值为1（或小于1）时，表示不递归监听子目录，监听所有子目录请传Integer.MAX_VALUE

返回:

this

close

public void close()

关闭监听

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable