java.nio.file

インタフェース Watchable

既知のすべてのサブインタフェース:

Path

public interface Watchable

変更およびイベントを監視できるように、監視サービスに登録できるオブジェクトです。

このインタフェースは、オブジェクトを WatchService に登録して、その登録を表す WatchKey を返す register メソッドを定義します。1 つのオブジェクトが複数の監視サービスに登録されることもあります。監視サービスへの登録は、鍵の cancel メソッドを呼び出すことにより取り消されます。

導入されたバージョン:

1.7

関連項目:

Path.register(java.nio.file.WatchService, java.nio.file.WatchEvent.Kind<?>[], java.nio.file.WatchEvent.Modifier...)

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>... events) オブジェクトを監視サービスに登録します。
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) オブジェクトを監視サービスに登録します。

メソッドの詳細

register

WatchKey register(WatchService watcher,
                WatchEvent.Kind<?>[] events,
                WatchEvent.Modifier... modifiers)
                  throws IOException

オブジェクトを監視サービスに登録します。

このオブジェクトで識別されるファイルシステムオブジェクトが現在監視サービスに登録されている場合は、events および modifiers パラメータで指定されるイベントセットまたはそれらへの修飾子の変更後に、その登録を表す監視鍵が返されます。イベントセットを変更しても、そのオブジェクトの保留中のイベントは破棄されません。OVERFLOW イベントのオブジェクトは自動的に登録されます。このイベントは、イベントの配列に含まれている必要はありません。

それ以外の場合、そのファイルシステムオブジェクトは指定された監視サービスにまだ登録されていないため、登録されて、結果となる新しい鍵が返されます。

このインタフェースの実装では、それがサポートしているイベントを指定するべきです。

パラメータ:

watcher - このオブジェクトを登録する監視サービス

events - このオブジェクトを登録するべきイベント

modifiers - オブジェクトの登録方法を修飾する修飾子 (ある場合)

戻り値:

指定された監視サービスへのこのオブジェクトの登録を表すキー

例外:

UnsupportedOperationException - 未サポートのイベントまたは修飾子が指定された場合

IllegalArgumentException - イベントや修飾子の無効な組み合わせが指定された場合

ClosedWatchServiceException - 監視サービスが閉じられている場合

IOException - 入出力エラーが発生した場合

SecurityException - セキュリティーマネージャーがインストールされ、それがこのオブジェクトを監視するために必要な未指定のアクセス権を拒否する場合。このインタフェースの実装は、アクセス権チェックを指定するべきです。

register

WatchKey register(WatchService watcher,
                WatchEvent.Kind<?>... events)
                  throws IOException

オブジェクトを監視サービスに登録します。

このメソッド呼び出しの動作は、次の呼び出しの動作とまったく同一です。

     watchable.register(watcher, events, new WatchEvent.Modifier[0]);
 

パラメータ:

watcher - このオブジェクトを登録する監視サービス

events - このオブジェクトを登録するべきイベント

戻り値:

指定された監視サービスへのこのオブジェクトの登録を表すキー

例外:

UnsupportedOperationException - サポートされていないイベントが指定された場合

IllegalArgumentException - イベントの無効な組み合わせが指定された場合

ClosedWatchServiceException - 監視サービスが閉じられている場合

IOException - 入出力エラーが発生した場合

SecurityException - セキュリティーマネージャーがインストールされ、それがこのオブジェクトを監視するために必要な未指定のアクセス権を拒否する場合。このインタフェースの実装は、アクセス権チェックを指定するべきです。