java.nio.file

インタフェース Path

すべてのスーパーインタフェース:

Comparable<Path>, Iterable<Path>, Watchable

public interface Path
extends Comparable<Path>, Iterable<Path>, Watchable

ファイルシステム内のファイルを特定するために使用可能なオブジェクトです。通常、それはシステムに依存するファイルパスを表します。

Path は、特別な区切り文字で区切られた一連のディレクトリ名およびファイル名の要素で構成される階層構造のパスを表します。ルートコンポーネント (ファイルシステム階層を識別するもの) が存在する場合もあります。ディレクトリ階層のルートからもっとも遠い名前要素は、ファイルまたはディレクトリの名前です。その他の名前要素はディレクトリ名です。Path は、ルート、ルートと一連の名前、または単に 1 つまたは複数の名前要素のみを表すことができます。Path は、1 つの空の名前要素のみで構成される場合は空のパスとみなされます。空のパスを使用してファイルにアクセスすることは、ファイルシステムのデフォルトディレクトリにアクセスすることと同じです。Path は、パスコンポーネントまたはその名前要素のサブシーケンスにアクセスするための getFileName、getParent、getRoot、および subpath メソッドを定義します。

Path は、パスコンポーネントにアクセスするほかに、パスを結合するための resolve および resolveSibling メソッドも定義します。relativize メソッドを使用すると、2 つのパス間の相対パスを構築できます。startsWith および endWith メソッドを使用してパスを相互に比較したり、テストしたりできます。

このインタフェースは、Watchable インタフェースを拡張して、パスで検索されるディレクトリを WatchService と監視されるディレクトリ内のエントリに登録できます。

警告: このインタフェースは、カスタムファイルシステムの実装を開発する人によって実装されることのみを目的としています。将来のリリースでは、このインタフェースにメソッドが追加される可能性があります。

ファイルへのアクセス

Files クラスで Path を使用することで、ファイル、ディレクトリ、およびその他の種類のファイルを操作できます。たとえば、BufferedReader でファイル「access.log」からテキストを読み取るとします。ファイルは、現在の作業ディレクトリからの相対ディレクトリ「logs」にあり、UTF-8 形式でエンコードされています。

     Path path = FileSystems.getDefault().getPath("logs", "access.log");
     BufferReader reader = Files.newBufferedReader(path, StandardCharsets.UTF_8);
 

相互運用性

デフォルトプロバイダに関連付けられた Path は通常、java.io.File クラスと相互運用可能です。ほかのプロバイダによって作成された Path は、java.io.File で表される抽象パス名と相互運用可能であることはまれです。toPath メソッドを使用すると、java.io.File オブジェクトで表される抽象パス名から Path を取得できます。結果の Path を使用すると、java.io.File オブジェクトと同じファイルを操作できます。さらに、toFile メソッドは、Path の String 表現から File を構築するのに役立ちます。

並行性

このインタフェースの実装は不変であり、複数の並行スレッドで安全に使用できます。

導入されたバージョン:

1.7

関連項目:

Paths

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
int	compareTo(Path other) 2 つの抽象パスを語彙的に比較します。
boolean	endsWith(Path other) このパスが、指定されたパスで終わるかどうかをテストします。
boolean	endsWith(String other) このパスが、endsWith(Path) メソッドで指定されたとおりの方法で指定のパス文字列を変換することで構築される、Path で終わるかどうかをテストします。
boolean	equals(Object other) このパスが指定されたオブジェクトと等しいかどうかをテストします。
Path	getFileName() このパスが示すファイルまたはディレクトリの名前を Path オブジェクトとして返します。
FileSystem	getFileSystem() このオブジェクトを作成したファイルシステムを返します。
Path	getName(int index) このパスの名前要素を Path オブジェクトとして返します。
int	getNameCount() パス内の名前要素の数を返します。
Path	getParent() 親のパスを返します。このパスが親を持たない場合は null を返します。
Path	getRoot() このパスのルートコンポーネントを Path オブジェクトとして返します。このパスがルートコンポーネントを持たない場合は null を返します。
int	hashCode() このパスのハッシュコードを計算します。
boolean	isAbsolute() このパスが絶対かどうかを通知します。
Iterator<Path>	iterator() このパスの名前要素を処理するイテレータを返します。
Path	normalize() このパスから冗長な名前要素を削除したパスを返します。
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>... events) このパスで検出されたファイルを監視サービスに登録します。
WatchKey	register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) このパスで検出されたファイルを監視サービスに登録します。
Path	relativize(Path other) このパスと指定されたパスとの間の相対パスを構築します。
Path	resolve(Path other) 指定されたパスをこのパスに対して解決します。
Path	resolve(String other) 指定されたパス文字列を Path に変換してから、resolve メソッドで指定されたとおりの方法で、この Path に対して解決します。
Path	resolveSibling(Path other) 指定されたパスをこのパスの親パスに対して解決します。
Path	resolveSibling(String other) 指定されたパス文字列を Path に変換してから、resolveSibling メソッドで指定されたとおりの方法で、このパスの親パスに対して解決します。
boolean	startsWith(Path other) このパスが、指定されたパスで始まるかどうかをテストします。
boolean	startsWith(String other) このパスが、startsWith(Path) メソッドで指定されたとおりの方法で指定のパス文字列を変換することで構築される、Path で始まるかどうかをテストします。
Path	subpath(int beginIndex, int endIndex) このパスの名前要素のサブシーケンスである相対 Path を返します。
Path	toAbsolutePath() このパスの絶対パスを表す Path オブジェクトを返します。
File	toFile() このパスを表す File オブジェクトを返します。
Path	toRealPath(LinkOption... options) 既存のファイルの実際のパスを返します。
String	toString() このパスの文字列表現を返します。
URI	toUri() このパスを表す URI を返します。

メソッドの詳細

getFileSystem

FileSystem getFileSystem()

このオブジェクトを作成したファイルシステムを返します。

戻り値:

このオブジェクトを作成したファイルシステム

isAbsolute

boolean isAbsolute()

このパスが絶対かどうかを通知します。

絶対パスは完全であり、ファイルを見つけるためにほかのパス情報と組み合わせる必要はありません。

戻り値:

このパスが絶対である場合にのみ true

getRoot

Path getRoot()

このパスのルートコンポーネントを Path オブジェクトとして返します。このパスがルートコンポーネントを持たない場合は null を返します。

戻り値:

このパスのルートコンポーネントを表すパス、または null

getFileName

Path getFileName()

このパスが示すファイルまたはディレクトリの名前を Path オブジェクトとして返します。このファイル名は、ディレクトリ階層のルートからもっとも遠い要素です。

戻り値:

ファイルまたはディレクトリの名前を表すパス。このパスに要素が含まれていない場合は null

getParent

Path getParent()

親のパスを返します。このパスが親を持たない場合は null を返します。

このパスオブジェクトの親は、このパスのルートコンポーネント (存在する場合) とパス内の各要素 (ディレクトリ階層のルートからもっとも遠い要素を除く) で構成されます。このメソッドはファイルシステムにアクセスしません。つまり、パスまたはその親が存在しない可能性があります。さらに、このメソッドでは一部の実装で使用できる「.」や「..」などの特殊な名前を削除しません。たとえば、UNIX では、「/a/b/c」の親は「/a/b」であり、「x/y/.」の親は「x/y」です。このメソッドを normalize メソッドとともに使用すると、シェルのようなナビゲーションが必要な場合に、冗長な名前を削除できます。

このパスに 1 つまたは複数の要素が含まれるが、ルートコンポーネントがない場合、このメソッドは次の式の評価と同等になります。

 subpath(0, getNameCount()-1);
 

戻り値:

そのパスの親を表すパス

getNameCount

int getNameCount()

パス内の名前要素の数を返します。

戻り値:

パス内の要素の数。このパスがルートコンポーネントのみを表す場合は 0

getName

Path getName(int index)

このパスの名前要素を Path オブジェクトとして返します。

index パラメータは、返される名前要素のインデックスです。ディレクトリ階層のルートにもっとも近い要素のインデックスは 0 になります。そのルートからもっとも遠い要素のインデックスは、要素数 -1 になります。

パラメータ:

index - 要素のインデックス

戻り値:

名前要素

例外:

IllegalArgumentException - index が負の値である場合、index が要素数と等しいか、それよりも大きい場合、またはこのパスに名前要素が含まれていない場合

subpath

Path subpath(int beginIndex,
           int endIndex)

このパスの名前要素のサブシーケンスである相対 Path を返します。

beginIndex および endIndex パラメータは、名前要素のサブシーケンスを指定します。ディレクトリ階層のルートにもっとも近い名前のインデックスは 0 になります。そのルートからもっとも遠い名前のインデックスは、要素数 -1 になります。返される Path オブジェクトには、beginIndex から始まり、インデックス endIndex-1 の要素にまで及ぶ名前要素が含まれます。

パラメータ:

beginIndex - 最初の要素のインデックス (これを含む)

endIndex - 最後の要素のインデックス (これを含まない)

戻り値:

この Path の名前要素のサブシーケンスである新しい Path オブジェクト

例外:

IllegalArgumentException - beginIndex が負の値である場合、またはそれが要素数に等しいか、それよりも大きい場合。endIndex が beginIndex に等しいか、それよりも小さい場合、またはそれが要素数よりも大きい場合。

startsWith

boolean startsWith(Path other)

このパスが、指定されたパスで始まるかどうかをテストします。

このパスのルートコンポーネントが指定されたパスのルートコンポーネントで始まり、かつこのパスが指定されたパスと同じ名前要素で始まる場合、このパスは指定されたパスで始まります。指定されたパスにこのパスよりも多くの名前要素が含まれている場合は、false が返されます。

このパスのルートコンポーネントが指定されたパスのルートコンポーネントで始まるかどうかは、ファイルシステムに固有です。このパスにルートコンポーネントが含まれておらず、指定されたパスにルートコンポーネントが含まれている場合、このパスは指定されたパスで始まりません。

指定されたパスがこのパスとは異なる FileSystem に関連付けられている場合、false が返されます。

パラメータ:

other - 指定されたパス

戻り値:

true このパスが、指定されたパスで始まる場合 true、そうでない場合 false

startsWith

boolean startsWith(String other)

このパスが、startsWith(Path) メソッドで指定されたとおりの方法で指定のパス文字列を変換することで構築される、Path で始まるかどうかをテストします。たとえば、UNIX では、パス「foo/bar」は「foo」および「foo/bar」で始まります。それは「f」または「fo」では始まりません。

パラメータ:

other - 指定されたパス文字列

戻り値:

このパスが、指定されたパスで始まる場合 true、それ以外の場合は false

例外:

InvalidPathException - パス文字列を Path に変換できない場合。

endsWith

boolean endsWith(Path other)

このパスが、指定されたパスで終わるかどうかをテストします。

指定されたパスには N 個の要素が含まれていて、ルートコンポーネントがなく、このパスには N 個以上の要素が含まれている場合、ルートからもっとも遠い要素で始まる、各パスの最後の N 個の要素が等しければ、このパスは指定されたパスで終わります。

指定されたパスにルートコンポーネントがある場合、このパスのルートコンポーネントが指定されたパスのルートコンポーネントで終わり、両方のパスの対応する要素が等しければ、このパスは指定されたパスで終わります。このパスのルートコンポーネントが指定されたパスのルートコンポーネントで終わるかどうかは、ファイルシステムに固有です。このパスにルートコンポーネントが含まれず、指定されたパスにルートコンポーネントが含まれている場合、このパスは指定されたパスで終わりません。

指定されたパスがこのパスとは異なる FileSystem に関連付けられている場合、false が返されます。

パラメータ:

other - 指定されたパス

戻り値:

このパスが指定されたパスで終わる場合は true、それ以外の場合は false

endsWith

boolean endsWith(String other)

このパスが、endsWith(Path) メソッドで指定されたとおりの方法で指定のパス文字列を変換することで構築される、Path で終わるかどうかをテストします。たとえば、UNIX では、パス「foo/bar」は「foo/bar」および「bar」で終わります。それは「r」または「/bar」では終わりません。末尾の区切り文字は考慮されないため、このメソッドを Path"foo/bar" に対して String "bar/" で呼び出すと、true が返されます。

パラメータ:

other - 指定されたパス文字列

戻り値:

true このパスが、指定されたパスで始まる場合 true、そうでない場合 false

例外:

InvalidPathException - パス文字列を Path に変換できない場合。

normalize

Path normalize()

このパスから冗長な名前要素を削除したパスを返します。

このメソッドの正確な定義は実装に依存しますが、通常、それはこのパス (冗長な名前要素を含まないパス) から派生しています。多くのファイルシステムでは、「.」および「..」は現在のディレクトリおよび親ディレクトリを示すために使われる特殊な名前です。そのようなファイルシステムでは、「.」のオカレンスはすべて冗長とみなされます。「..」の直前に「..」以外の名前が存在する場合、その両方の名前が冗長とみなされます (そのような名前を識別するプロセスが該当しなくなるまで繰り返される)。

このメソッドはファイルシステムにアクセスしません。つまり、そのパスは存在しているファイルを検出しない可能性があります。「..」とそれに先行する名前をパスから削除すると、元のパスとは異なるファイルを検出するパスが生じる可能性があります。これは、先行する名前がシンボリックリンクの場合に発生することがあります。

戻り値:

結果となるパスまたはこのパス (このパスに冗長な名前要素が含まれていない場合)。このパスにルートコンポーネントがあり、すべての名前要素が冗長な場合は空のパスが返される

関連項目:

getParent(), toRealPath(java.nio.file.LinkOption...)

resolve

Path resolve(Path other)

指定されたパスをこのパスに対して解決します。

other パラメータが絶対パスである場合、このメソッドは普通に other を返します。other が空のパスである場合、このメソッドは普通にこのパスを返します。それ以外の場合、このメソッドはこのパスをディレクトリとみなし、指定されたパスをこのパスに対して解決します。もっとも単純なのは、指定されたパスにルートコンポーネントがない場合です。その場合、このメソッドは指定されたパスをこのパスに結合し、指定されたパスで終わるパスを結果として返します。指定されたパスにルートコンポーネントがある場合、解決は実装に大きく依存するため、未指定です。

パラメータ:

other - このパスに対して解決するパス

戻り値:

結果のパス

関連項目:

relativize(java.nio.file.Path)

resolve

Path resolve(String other)

指定されたパス文字列を Path に変換してから、resolve メソッドで指定されたとおりの方法で、この Path に対して解決します。たとえば、名前区切り文字が「/」で、パスが「foo/bar」を表すとします。このメソッドをパス文字列「gus」で呼び出すと、結果は Path "foo/bar/gus" となります。

パラメータ:

other - このパスに対して解決するパス文字列

戻り値:

結果のパス

例外:

InvalidPathException - パス文字列を Path に変換できない場合。

関連項目:

FileSystem.getPath(java.lang.String, java.lang.String...)

resolveSibling

Path resolveSibling(Path other)

指定されたパスをこのパスの親パスに対して解決します。これは、ファイル名を別のファイル名に置き換える必要がある場合に役立ちます。たとえば、名前区切り文字が「/」で、パスが「dir1/dir2/foo」を表すとします。このメソッドを Path "bar" で呼び出すと、結果は Path "dir1/dir2/bar" となります。このパスに親パスが含まれていない場合、または other が絶対パスである場合、このメソッドは other を返します。other が空のパスである場合、このメソッドはこのパスの親を返し、このパスに親がない場合は、空のパスを返します。

パラメータ:

other - このパスの親に対して解決するパス

戻り値:

結果のパス

関連項目:

resolve(Path)

resolveSibling

Path resolveSibling(String other)

指定されたパス文字列を Path に変換してから、resolveSibling メソッドで指定されたとおりの方法で、このパスの親パスに対して解決します。

パラメータ:

other - このパスの親に対して解決するパス文字列

戻り値:

結果のパス

例外:

InvalidPathException - パス文字列を Path に変換できない場合。

関連項目:

FileSystem.getPath(java.lang.String, java.lang.String...)

relativize

Path relativize(Path other)

このパスと指定されたパスとの間の相対パスを構築します。

相対化は、解決の逆です。このメソッドは、このパスに対して解決すると指定されたパスと同じファイルを検出するパスを生成する、相対パスを構築しようとします。たとえば、UNIX では、このパスが "/a/b" で、指定されたパスが "/a/b/c/d" である場合、結果となる相対パスは "c/d" になります。このパスと指定されたパスにルートコンポーネントがない場合は、相対パスを構築できます。それらのパスのどちらか一方だけにルートコンポーネントがある場合は、相対パスを構築できません。両方のパスにルートコンポーネントがある場合、相対パスを構築できるかどうかは実装に依存します。このパスと指定されたパスが等しい場合は、空のパスが返されます。

2 つの正規化されたパス p と q について (ここでの q にはルートコンポーネントがありません)、次が成り立ちます。

p.relativize(p.resolve(q)).equals(q)

シンボリックリンクがサポートされている場合、このパスに対して解決すると、結果となるパスが、other と同じファイルの検出に使用できるパスを生成するかどうかは実装に依存します。たとえば、このパスが "/a/b" で、指定されたパスが "/a/x" である場合、結果となる相対パスは "../x" になります。"b" がシンボリックリンクの場合、"a/b/../x" が "/a/x" と同じファイルを検出するかどうかは実装に依存します。

パラメータ:

other - このパスに対して相対化するパス

戻り値:

結果となる相対パス。両方のパスが等しい場合は空のパス

例外:

IllegalArgumentException - other がこのパスに対して相対化できる Path でない場合

toUri

URI toUri()

このパスを表す URI を返します。

このメソッドは、プロバイダを識別する URI スキームに等しいスキームを使用して、絶対 URI を構築します。スキーム固有の部分の正確な形式はプロバイダに大きく依存します。

デフォルトプロバイダの場合、URI は絶対であるパスコンポーネントを含む階層 URI です。クエリーおよびフラグメントコンポーネントは未定義です。機関コンポーネントが定義されているかどうかは、実装に依存します。URI が java.io.File の構築に使用できるという保証はありません。特に、このパスが汎用命名規則 (UNC) パスを表す場合は、UNC サーバー名を結果となる URI の機関コンポーネントでエンコードできます。デフォルトプロバイダで、ファイルが存在し、そのファイルがディレクトリであると判定できる場合、結果となる URI はスラッシュで終わります。

デフォルトプロバイダは同様のラウンドトリップの保証を File クラスに提供します。Path p が指定された場合は、次が保証されます。

Paths.get(p.toUri()).equals(p .toAbsolutePath())

この例の場合、元の Path、URI、および新しい Path は、同じ Java 仮想マシンの複数の呼び出しで作成する必要があります。ほかのプロバイダが保証を行うかどうかはプロバイダによって異なるため、未指定です。

ファイルの内容にファイルシステムとしてアクセスするためのファイルシステムが構築される場合、返される URI がそのファイルシステム内の指定されたパスを表すか、または包含するファイルシステムの URI をエンコードする複合 URI を表すかは、実装によって大きく異なります。このリリースでは、複合 URI の形式は定義されていません。そのようなスキームは、将来のリリースで追加される可能性があります。

戻り値:

このパスを表す URI

例外:

IOError - 絶対パスの取得中に入出力エラーが発生した場合、またはファイルの内容にファイルシステムとしてアクセスするためのファイルシステムが構築され、包含するファイルシステムの URI を取得できない場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、その toAbsolutePath メソッドがセキュリティー例外をスローする場合。

toAbsolutePath

Path toAbsolutePath()

このパスの絶対パスを表す Path オブジェクトを返します。

このパスがすでに絶対である場合、このメソッドは単にこのパスを返すだけです。それ以外の場合、このメソッドはそのパスを実装に依存した方法で (通常はそのパスをファイルシステムのデフォルトディレクトリに対して解決することによって) 解決します。実装によっては、このメソッドはファイルシステムにアクセスできない場合に入出力エラーをスローすることがあります。

戻り値:

絶対パスを表す Path オブジェクト

例外:

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、このパスが絶対でない場合、セキュリティーマネージャーの checkPropertyAccess メソッドが呼び出されてシステムプロパティー user.dir へのアクセスがチェックされる

toRealPath

Path toRealPath(LinkOption... options)
                throws IOException

既存のファイルの実際のパスを返します。

このメソッドの正確な定義は実装に依存しますが、通常、それはこのパス (このパスと同じファイルを検出するが、ディレクトリおよびファイルの実際の名前を表す名前要素を含む絶対パス) から派生しています。たとえば、ファイルシステムに対するファイル名の比較で大文字と小文字が区別されない場合、名前要素は大文字と小文字の違いを実際に合わせて名前を表します。また、結果となるパスからは冗長な名前要素が削除されています。

このパスが相対である場合は、toAbsolutePath メソッドを呼び出した場合と同様に、最初にその絶対パスが取得されます。

options 配列を使用すると、シンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはその最終ターゲットに解決されます。オプション NOFOLLOW_LINKS が存在する場合、このメソッドはシンボリックリンクを解決しません。 一部の実装では、「..」などの特殊な名前を使用して親ディレクトリを参照できます。実際のパスを取得しているときに、「..」 (また同等のもの) の直前に「..」以外の名前が存在する場合は、実装によって通常、両方の名前が削除されます。シンボリックリンクを解決していないときに、先行する名前がシンボリックリンクである場合は、結果となるパスがこのパスと同じファイルを検出することが保証されていれば、それらの名前は削除されます。

パラメータ:

options - シンボリックリンクの処理方法を示すオプション

戻り値:

このオブジェクトによって検出されるファイルの実際のパスを表す絶対パス

例外:

IOException - ファイルが存在しないか、入出力エラーが発生した場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、その checkRead メソッドが呼び出されてファイルへの読み取りアクセスがチェックされ、このパスが絶対でない場合は、その checkPropertyAccess メソッドが呼び出されてシステムプロパティー user.dir へのアクセスがチェックされる

toFile

File toFile()

このパスを表す File オブジェクトを返します。この Path がデフォルトプロバイダに関連付けられている場合、このメソッドは、このパスの String 表現で構築された File オブジェクトを返すことと同等です。

このパスが File toPath メソッドを呼び出すことで作成された場合は、このメソッドによって返された File オブジェクトが元の File に等しいという保証はありません。

戻り値:

このパスを表す File オブジェクト

例外:

UnsupportedOperationException - この Path がデフォルトプロバイダに関連付けられていない場合

register

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

このパスで検出されたファイルを監視サービスに登録します。

このリリースでは、このパスは存在しているディレクトリを検出します。そのディレクトリは、ディレクトリ内のエントリを監視できるように監視サービスに登録されます。events パラメータは登録するイベントであり、次のイベントを含めることができます。

• ENTRY_CREATE - エントリがディレクトリ内に作成または移動された
• ENTRY_DELETE - エントリがディレクトリから削除または取り出された
• ENTRY_MODIFY - ディレクトリ内のエントリが変更された

これらのイベントのコンテキストは、このパスで検出されるディレクトリと、作成、削除、または変更されるディレクトリエントリを検出するパスとの間の相対パスになります。

イベントのセットには、列挙型の StandardWatchEventKinds で定義されない実装固有の追加のイベントを含めることができます。

modifiers パラメータは、ディレクトリの登録方法を修飾する修飾子を指定します。このリリースでは、標準修飾子は定義されていません。それには、実装固有の修飾子を含めることができます。

ファイルがシンボリックリンクによって監視サービスに登録される場合、登録後も監視がそのシンボリックリンクの存在に左右され続けるかどうかは実装に固有です。

定義:

register、インタフェース: Watchable

パラメータ:

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

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

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

戻り値:

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

例外:

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

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

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

NotDirectoryException - ディレクトリ内のエントリを監視するようにファイルが登録されているが、そのファイルがディレクトリではない場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkRead メソッドが呼び出されてファイルへの読み取りアクセスがチェックされます。

register

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

このパスで検出されたファイルを監視サービスに登録します。

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

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

使用例: エントリの作成、削除、および変更イベント用にディレクトリを登録するとします。

     Path dir = ...
     WatchService watcher = ...

     WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);
 

定義:

register、インタフェース: Watchable

パラメータ:

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

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

戻り値:

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

例外:

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

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

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

NotDirectoryException - ディレクトリ内のエントリを監視するようにファイルが登録されているが、そのファイルがディレクトリではない場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkRead メソッドが呼び出されてファイルへの読み取りアクセスがチェックされます。

iterator

Iterator<Path> iterator()

このパスの名前要素を処理するイテレータを返します。

イテレータによって返される最初の要素は、ディレクトリ階層のルートにもっとも近い名前要素を表し、2 番目の要素は次にもっとも近い名前要素となり、以降も同様です。返される最後の要素は、このパスで示されるファイルまたはディレクトリの名前です。イテレータでは、ルートコンポーネント (存在する場合) は返されません。

定義:

iterator、インタフェース: Iterable<Path>

戻り値:

このパスの名前要素を処理するイテレータ。

compareTo

int compareTo(Path other)

2 つの抽象パスを語彙的に比較します。このメソッドで定義される順序はプロバイダに固有であり、デフォルトプロバイダの場合はプラットフォームに固有です。このメソッドはファイルシステムにアクセスしないため、ファイルが存在していなくてもかまいません。

このメソッドを使って異なるファイルシステムプロバイダに関連付けられているパスを比較することはできません。

定義:

compareTo、インタフェース: Comparable<Path>

パラメータ:

other - このパスと比較されるパス。

戻り値:

引数がこのパスと等しい場合はゼロ。このパスが引数より語彙的に小さい場合は負の値。このパスが引数より語彙的に大きい場合は正の値

例外:

ClassCastException - パスが異なるプロバイダに関連付けられている場合

equals

boolean equals(Object other)

このパスが指定されたオブジェクトと等しいかどうかをテストします。

指定されたオブジェクトが Path でないか、別の FileSystem に関連付けられた Path である場合、このメソッドは false を返します。

2 つのパスが等しいかどうかは、ファイルシステムの実装によって異なります。それらのパスは大文字小文字の区別なく比較される場合も、大文字小文字を区別して比較される場合もあります。このメソッドはファイルシステムにアクセスしないため、ファイルが存在していなくてもかまいません。必要な場合は、isSameFile メソッドを使用して 2 つのパスが同じファイルを検出するかどうかを確認できます。

このメソッドは Object.equals の汎用規約を満たします。

オーバーライド:

equals、クラス: Object

パラメータ:

other - このオブジェクトと比較するオブジェクト

戻り値:

指定されたオブジェクトがこの Path と同じ Path である場合にのみ true

関連項目:

Object.hashCode(), HashMap

hashCode

int hashCode()

このパスのハッシュコードを計算します。

ハッシュコードは、パスのコンポーネントに基づいており、Object.hashCode メソッドの汎用規約を満たします。

オーバーライド:

hashCode、クラス: Object

戻り値:

このパスのハッシュコード値

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

String toString()

このパスの文字列表現を返します。

getPath メソッドを使用してパス文字列を変換することでこのパスが作成された場合は、このメソッドによって返されるパス文字列がパスの作成に使用された元の String と異なることがあります。

返されるパス文字列は、デフォルトの名前区切り文字を使用してパスの名前を区切ります。

オーバーライド:

toString、クラス: Object

戻り値:

このパスの文字列表現