-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathWatchable.java
More file actions
127 lines (120 loc) · 4.34 KB
/
Watchable.java
File metadata and controls
127 lines (120 loc) · 4.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
* Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package java.nio.file;
import java.io.IOException;
/**
* An object that may be registered with a watch service so that it can be
* <em>watched</em> for changes and events.
*
* <p> This interface defines the {@link #register register} method to register
* the object with a {@link WatchService} returning a {@link WatchKey} to
* represent the registration. An object may be registered with more than one
* watch service. Registration with a watch service is cancelled by invoking the
* key's {@link WatchKey#cancel cancel} method.
*
* @since 1.7
*
* @see Path#register
*/
public interface Watchable {
/**
* Registers an object with a watch service.
*
* <p> If the file system object identified by this object is currently
* registered with the watch service then the watch key, representing that
* registration, is returned after changing the event set or modifiers to
* those specified by the {@code events} and {@code modifiers} parameters.
* Changing the event set does not cause pending events for the object to be
* discarded. Objects are automatically registered for the {@link
* StandardWatchEventKinds#OVERFLOW OVERFLOW} event. This event is not
* required to be present in the array of events.
*
* <p> Otherwise the file system object has not yet been registered with the
* given watch service, so it is registered and the resulting new key is
* returned.
*
* <p> Implementations of this interface should specify the events they
* support.
*
* @param watcher
* the watch service to which this object is to be registered
* @param events
* the events for which this object should be registered
* @param modifiers
* the modifiers, if any, that modify how the object is registered
*
* @return a key representing the registration of this object with the
* given watch service
*
* @throws UnsupportedOperationException
* if unsupported events or modifiers are specified
* @throws IllegalArgumentException
* if an invalid of combination of events are modifiers are specified
* @throws ClosedWatchServiceException
* if the watch service is closed
* @throws IOException
* if an I/O error occurs
* @throws SecurityException
* if a security manager is installed and it denies an unspecified
* permission required to monitor this object. Implementations of
* this interface should specify the permission checks.
*/
WatchKey register(WatchService watcher,
WatchEvent.Kind<?>[] events,
WatchEvent.Modifier... modifiers)
throws IOException;
/**
* Registers an object with a watch service.
*
* <p> An invocation of this method behaves in exactly the same way as the
* invocation
* <pre>
* watchable.{@link #register(WatchService,WatchEvent.Kind[],WatchEvent.Modifier[]) register}(watcher, events, new WatchEvent.Modifier[0]);
* </pre>
*
* @param watcher
* the watch service to which this object is to be registered
* @param events
* the events for which this object should be registered
*
* @return a key representing the registration of this object with the
* given watch service
*
* @throws UnsupportedOperationException
* if unsupported events are specified
* @throws IllegalArgumentException
* if an invalid of combination of events are specified
* @throws ClosedWatchServiceException
* if the watch service is closed
* @throws IOException
* if an I/O error occurs
* @throws SecurityException
* if a security manager is installed and it denies an unspecified
* permission required to monitor this object. Implementations of
* this interface should specify the permission checks.
*/
WatchKey register(WatchService watcher, WatchEvent.Kind<?>... events)
throws IOException;
}