WatchUtil (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.core.io.watch.WatchUtil

```
public class WatchUtil
extends Object
```
监听工具类
主要负责文件监听器的快捷创建

Since:

3.1.0

Author:

Looly

Constructor Summary

Constructors
Constructor and Description

WatchUtil()

Constructors
Constructor and Description
`WatchUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static WatchMonitor`	`of(File file, int maxDepth, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(File file, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(Path path, int maxDepth, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(Path path, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(String path, int maxDepth, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(String path, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(URI uri, int maxDepth, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(URI uri, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(URL url, int maxDepth, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`of(URL url, WatchEvent.Kind<?>... events)` 创建并初始化监听
`static WatchMonitor`	`ofAll(File file, int maxDepth, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(File file, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(Path path, int maxDepth, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(Path path, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(String path, int maxDepth, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(String path, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(URI uri, int maxDepth, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(URI uri, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(URL url, int maxDepth, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofAll(URL url, Watcher watcher)` 创建并初始化监听，监听所有事件
`static WatchMonitor`	`ofModify(File file, int maxDepth, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(File file, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(Path path, int maxDepth, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(Path path, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(String path, int maxDepth, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(String path, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(URI uri, int maxDepth, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(URI uri, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(URL url, int maxDepth, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchMonitor`	`ofModify(URL url, Watcher watcher)` 创建并初始化监听，监听修改事件
`static WatchKey`	`register(Watchable watchable, WatchService watcher, WatchEvent.Kind<?>... events)` 注册Watchable对象到WatchService服务
`static Path`	`resolvePath(WatchEvent<?> event, WatchKey key)` 获取触发事件中相对监听Path的完整路径

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WatchUtil
```
public WatchUtil()
```
- Method Detail
  - of
```
public static WatchMonitor of(URL url,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    url - URL
    
    events - 监听的事件列表
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(URL url,
                              int maxDepth,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    url - URL
    
    events - 监听的事件列表
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(URI uri,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    uri - URI
    
    events - 监听的事件列表
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(URI uri,
                              int maxDepth,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    uri - URI
    
    events - 监听的事件列表
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(File file,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    file - 文件
    
    events - 监听的事件列表
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(File file,
                              int maxDepth,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    file - 文件
    
    events - 监听的事件列表
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(String path,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    path - 路径
    
    events - 监听的事件列表
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(String path,
                              int maxDepth,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    path - 路径
    
    events - 监听的事件列表
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(Path path,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    path - 路径
    
    events - 监听事件列表
    
    Returns:
    
    监听对象
  - of
```
public static WatchMonitor of(Path path,
                              int maxDepth,
                              WatchEvent.Kind<?>... events)
```
    创建并初始化监听
    
    Parameters:
    
    path - 路径
    
    events - 监听事件列表
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    Returns:
    
    监听对象
  - ofAll
```
public static WatchMonitor ofAll(URL url,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    url - URL
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(URL url,
                                 int maxDepth,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    url - URL
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(URI uri,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    uri - URI
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(URI uri,
                                 int maxDepth,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    uri - URI
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(File file,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    file - 被监听文件
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(File file,
                                 int maxDepth,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    file - 被监听文件
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(String path,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    path - 路径
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(String path,
                                 int maxDepth,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    path - 路径
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(Path path,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    path - 路径
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofAll
```
public static WatchMonitor ofAll(Path path,
                                 int maxDepth,
                                 Watcher watcher)
```
    创建并初始化监听，监听所有事件
    
    Parameters:
    
    path - 路径
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
  - ofModify
```
public static WatchMonitor ofModify(URL url,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    url - URL
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(URL url,
                                    int maxDepth,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    url - URL
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(URI uri,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    uri - URI
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(URI uri,
                                    int maxDepth,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    uri - URI
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(File file,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    file - 被监听文件
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(File file,
                                    int maxDepth,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    file - 被监听文件
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(String path,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    path - 路径
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(String path,
                                    int maxDepth,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    path - 路径
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(Path path,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    path - 路径
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - ofModify
```
public static WatchMonitor ofModify(Path path,
                                    int maxDepth,
                                    Watcher watcher)
```
    创建并初始化监听，监听修改事件
    
    Parameters:
    
    path - 路径
    
    maxDepth - 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录
    
    watcher - Watcher
    
    Returns:
    
    WatchMonitor
    
    Since:
    
    4.5.2
  - register
```
public static WatchKey register(Watchable watchable,
                                WatchService watcher,
                                WatchEvent.Kind<?>... events)
```
    注册Watchable对象到WatchService服务
    
    Parameters:
    
    watchable - 可注册对象
    
    watcher - WatchService对象
    
    events - 监听事件
    
    Returns:
    
    WatchKey
    
    Since:
    
    4.6.9
  - resolvePath
```
public static Path resolvePath(WatchEvent<?> event,
                               WatchKey key)
```
    获取触发事件中相对监听Path的完整路径
    
    Parameters:
    
    event - 事件
    
    key - WatchKey
    
    Returns:
    
    完整路径

Class WatchUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WatchUtil

Method Detail

of

of

of

of

of

of

of

of

of

of

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofModify

ofModify

ofModify

ofModify

ofModify

ofModify

ofModify

ofModify

ofModify

ofModify

register

resolvePath