java.nio.file

クラス Files

java.lang.Object

java.nio.file.Files

public final class Files
extends Object

このクラスは、ファイル、ディレクトリ、またはその他の種類のファイルを操作する static メソッドだけで構成されます。

ほとんどの場合、ここで定義されているメソッドは関連付けられたファイルシステムプロバイダにファイル操作の実行を委譲します。

導入されたバージョン:

1.7

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
static long	copy(InputStream in, Path target, CopyOption... options) すべてのバイトを入力ストリームからファイルにコピーします。
static long	copy(Path source, OutputStream out) すべてのバイトをファイルから出力ストリームにコピーします。
static Path	copy(Path source, Path target, CopyOption... options) ファイルをターゲットファイルにコピーします。
static Path	createDirectories(Path dir, FileAttribute<?>... attrs) 存在しないすべての親ディレクトリをまず作成することで、ディレクトリを作成します。
static Path	createDirectory(Path dir, FileAttribute<?>... attrs) 新しいディレクトリを作成します。
static Path	createFile(Path path, FileAttribute<?>... attrs) 新しい空のファイルを作成し、ファイルがすでに存在する場合は失敗します。
static Path	createLink(Path link, Path existing) 既存のファイルに対して新しいリンク (ディレクトリエントリ) を作成します (オプションの操作)。
static Path	createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs) ターゲットへのシンボリックリンクを作成します (オプションの操作)。
static Path	createTempDirectory(Path dir, String prefix, FileAttribute<?>... attrs) 指定されたディレクトリで新しいディレクトリを生成し、その名前には、指定された接頭辞が使用されます。
static Path	createTempDirectory(String prefix, FileAttribute<?>... attrs) デフォルトの一時ファイルディレクトリで新しいディレクトリを生成し、その名前には、指定された接頭辞が使用されます。
static Path	createTempFile(Path dir, String prefix, String suffix, FileAttribute<?>... attrs) 指定されたディレクトリで新しい空のファイルを生成し、その名前には、指定された接頭辞および接尾辞の文字列が使用されます。
static Path	createTempFile(String prefix, String suffix, FileAttribute<?>... attrs) 指定された接頭辞と接尾辞をファイル名の生成に使用して、デフォルトの一時ファイルディレクトリに空のファイルを生成します。
static void	delete(Path path) ファイルを削除します。
static boolean	deleteIfExists(Path path) ファイルが存在する場合は削除します。
static boolean	exists(Path path, LinkOption... options) ファイルが存在するかどうかをテストします。
static Object	getAttribute(Path path, String attribute, LinkOption... options) ファイル属性の値を読み取ります。
static <V extends FileAttributeView> V	getFileAttributeView(Path path, Class<V> type, LinkOption... options) 指定されたタイプのファイル属性ビューを返します。
static FileStore	getFileStore(Path path) ファイルが置かれているファイルストアを表す FileStore を返します。
static FileTime	getLastModifiedTime(Path path, LinkOption... options) ファイルの最終変更時間を返します。
static UserPrincipal	getOwner(Path path, LinkOption... options) ファイルの所有者を返します。
static Set<PosixFilePermission>	getPosixFilePermissions(Path path, LinkOption... options) ファイルの POSIX ファイルアクセス権を返します。
static boolean	isDirectory(Path path, LinkOption... options) ファイルがディレクトリかどうかをテストします。
static boolean	isExecutable(Path path) ファイルが実行可能かどうかをテストします。
static boolean	isHidden(Path path) ファイルが隠しファイルとみなされるかどうかを判断します。
static boolean	isReadable(Path path) ファイルが読み取り可能かどうかをテストします。
static boolean	isRegularFile(Path path, LinkOption... options) ファイルが不透明な内容の通常ファイルかどうかをテストします。
static boolean	isSameFile(Path path, Path path2) 2 つのパスが同じファイルを検出するかどうかを判断します。
static boolean	isSymbolicLink(Path path) ファイルがシンボリックリンクかどうかをテストします。
static boolean	isWritable(Path path) ファイルが書き込み可能かどうかをテストします。
static Path	move(Path source, Path target, CopyOption... options) ファイルをターゲットファイルに移動するか、そのファイル名を変更します。
static BufferedReader	newBufferedReader(Path path, Charset cs) ファイルを読み取り用に開き、そのファイルから効果的な方法でテキストを読み取るために使用できる BufferedReader を返します。
static BufferedWriter	newBufferedWriter(Path path, Charset cs, OpenOption... options) ファイルを書き込み用に開くか作成して、そのファイルに効果的な方法でテキストを書き込むために使用できる BufferedWriter を返します。
static SeekableByteChannel	newByteChannel(Path path, OpenOption... options) ファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。
static SeekableByteChannel	newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) ファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。
static DirectoryStream<Path>	newDirectoryStream(Path dir) ディレクトリを開き、ディレクトリ内のすべてのエントリを反復するための DirectoryStream を返します。
static DirectoryStream<Path>	newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) ディレクトリを開き、そのディレクトリ内のエントリに対して反復処理を行う DirectoryStream を返します。
static DirectoryStream<Path>	newDirectoryStream(Path dir, String glob) ディレクトリを開き、そのディレクトリ内のエントリに対して反復処理を行う DirectoryStream を返します。
static InputStream	newInputStream(Path path, OpenOption... options) ファイルを開き、そのファイルから読み取る入力ストリームを返します。
static OutputStream	newOutputStream(Path path, OpenOption... options) ファイルを開くか作成して、そのファイルにバイトを書き込むために使用できる出力ストリームを返します。
static boolean	notExists(Path path, LinkOption... options) このパスが示すファイルが存在しないかどうかをテストします。
static String	probeContentType(Path path) ファイルのコンテンツタイプを調べます。
static byte[]	readAllBytes(Path path) ファイルからすべてのバイトを読み取ります。
static List<String>	readAllLines(Path path, Charset cs) ファイルからすべての行を読み取ります。
static <A extends BasicFileAttributes> A	readAttributes(Path path, Class<A> type, LinkOption... options) 一括操作としてファイル属性を読み取ります。
static Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options) 一括操作として一連のファイル属性を読み取ります。
static Path	readSymbolicLink(Path link) シンボリックリンクのターゲットを読み取ります (オプションの操作)。
static Path	setAttribute(Path path, String attribute, Object value, LinkOption... options) ファイル属性の値を設定します。
static Path	setLastModifiedTime(Path path, FileTime time) ファイルの最終変更時間属性を更新します。
static Path	setOwner(Path path, UserPrincipal owner) ファイル所有者を更新します。
static Path	setPosixFilePermissions(Path path, Set<PosixFilePermission> perms) ファイルの POSIX ファイルアクセス権を設定します。
static long	size(Path path) ファイルのサイズをバイトで返します。
static Path	walkFileTree(Path start, FileVisitor<? super Path> visitor) ファイルツリーを参照します。
static Path	walkFileTree(Path start, Set<FileVisitOption> options, int maxDepth, FileVisitor<? super Path> visitor) ファイルツリーを参照します。
static Path	write(Path path, byte[] bytes, OpenOption... options) バイトをファイルに書き込みます。
static Path	write(Path path, Iterable<? extends CharSequence> lines, Charset cs, OpenOption... options) テキスト行をファイルに書き込みます。

クラス java.lang.Object から継承されたメソッド

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

メソッドの詳細

newInputStream

public static InputStream newInputStream(Path path,
                         OpenOption... options)
                                  throws IOException

ファイルを開き、そのファイルから読み取る入力ストリームを返します。そのストリームはバッファーに入れられないため、mark または reset メソッドをサポートしている必要はありません。ストリームは複数の並行スレッドからのアクセスに対して安全です。読み取りはファイルの最初から始まります。返されるストリームが非同期クローズ可能または割り込み可能、あるいはその両方かどうかは、ファイルシステムプロバイダによって大きく異なるため、未指定です。

options パラメータはファイルを開く方法を決定します。オプションが 1 つも存在しない場合、それは READ オプションでファイルを開くことと同等です。実装では、READ オプションのほかに、追加の実装固有のオプションをサポートすることもあります。

パラメータ:

path - 開くファイルへのパス

options - ファイルを開く方法を指定するオプション

戻り値:

新しい入力ストリーム

例外:

IllegalArgumentException - オプションの無効な組み合わせが指定された場合

UnsupportedOperationException - 未サポートのオプションが指定された場合

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

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

newOutputStream

public static OutputStream newOutputStream(Path path,
                           OpenOption... options)
                                    throws IOException

ファイルを開くか作成して、そのファイルにバイトを書き込むために使用できる出力ストリームを返します。結果となるストリームはバッファーに入れられません。ストリームは複数の並行スレッドからのアクセスに対して安全です。返されるストリームが非同期クローズ可能または割り込み可能、あるいはその両方かどうかは、ファイルシステムプロバイダによって大きく異なるため、未指定です。

このメソッドは、オプションの配列に READ オプションが含まれない可能性があることを除いては、newByteChannel メソッドで指定されたとおりにファイルを開くか作成します。オプションがない場合、このメソッドは CREATE、TRUNCATE_EXISTING、および WRITE オプションがあるかのように機能します。つまり、書き込み用にファイルを開きます (存在しない場合は作成し、存在する場合は最初に既存の通常ファイルをサイズ 0 に切り詰めます)。

使用例:

     Path path = ...

     // truncate and overwrite an existing file, or create the file if
     // it doesn't initially exist
     OutputStream out = Files.newOutputStream(path);

     // append to an existing file, fail if the file does not exist
     out = Files.newOutputStream(path, APPEND);

     // append to an existing file, create file if it doesn't initially exist
     out = Files.newOutputStream(path, CREATE, APPEND);

     // always create new file, failing if it already exists
     out = Files.newOutputStream(path, CREATE_NEW);
 

パラメータ:

path - 開くまたは作成するファイルへのパス

options - ファイルを開く方法を指定するオプション

戻り値:

新しい出力ストリーム

例外:

IllegalArgumentException - options にオプションの無効な組み合わせが含まれる場合

UnsupportedOperationException - 未サポートのオプションが指定された場合

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkWrite メソッドが呼び出されてファイルへの書き込みアクセスがチェックされます。DELETE_ON_CLOSE オプションでファイルが開かれた場合は、checkDelete メソッドが呼び出されて削除アクセスがチェックされます。

newByteChannel

public static SeekableByteChannel newByteChannel(Path path,
                                 Set<? extends OpenOption> options,
                                 FileAttribute<?>... attrs)
                                          throws IOException

ファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。

options パラメータはファイルを開く方法を決定します。READ と WRITE オプションにより、ファイルを読み取りまたは書き込みで開くべきかどうかが決定されます。いずれのオプション (または APPEND オプション) も存在しない場合、ファイルは読み取り用に開かれます。デフォルトでは、読み取りまたは書き込みはファイルの先頭から始まります。

READ および WRITE 以外に、次のオプションが存在する場合があります。

オプション	説明
APPEND	このオプションが存在する場合は、ファイルは書き込みのために開かれ、チャネルの write メソッドの各呼び出しは、まず位置をファイルの終わりに進めてから要求されたデータを書き込みます。このような位置の移動とデータの書き込みは、不可分な単一の操作として行われます。この操作は、システムに依存しているため未指定です。このオプションは、READ または TRUNCATE_EXISTING オプションと同時には使用できません。
TRUNCATE_EXISTING	このオプションが存在する場合は、既存のファイルはサイズが 0 バイトに切り詰められます。このオプションは、ファイルを読み取り専用に開いた場合は無視されます。
CREATE_NEW	このオプションが存在する場合は、新しいファイルが作成され、ファイルがすでに存在するか、シンボリックリンクである場合は失敗します。ファイルの作成時に、ファイルがあるかどうかのチェックや、ない場合のファイルの生成は、ほかのファイルシステムの操作に対して原子的です。このオプションは、ファイルを読み取り専用に開いた場合は無視されます。
CREATE	このオプションが存在する場合は、既存のファイルが存在する場合はそれが開かれ、そうでない場合は新しいファイルが作成されます。このオプションは、CREATE_NEW オプションも存在する場合またはファイルを読み取り専用に開いた場合は無視されます。
DELETE_ON_CLOSE	このオプションが存在する場合、実装は、ファイルが close メソッドによって閉じられるときに、ベストエフォートでファイルを削除しようとします。close メソッドが呼び出されない場合、Java 仮想マシンの終了時にファイルを削除するためのベストエフォートの試みが行われます。
SPARSE	新しいファイルの作成時に、このオプションは新しいファイルがスパースであることのヒントになります。このオプションは、新しいファイルを作成しない場合は無視されます。
SYNC	ファイルの内容またはメタデータの更新は、基本となる記憶装置に同期的に書き込まれることを必要とします。(「同期入出力ファイル整合性」を参照)。
DSYNC	ファイルの内容の更新は、基本となる記憶装置に同期的に書き込まれることを必要とします。(「同期入出力ファイル整合性」を参照)。

実装では、追加の実装固有のオプションをサポートすることもあります。

attrs パラメータは、新しいファイルの作成時に原子的に設定するオプションのファイル属性です。

デフォルトプロバイダの場合、返されるシーク可能なバイトチャネルは FileChannel です。

使用例:

     Path path = ...

     // open file for reading
     ReadableByteChannel rbc = Files.newByteChannel(path, EnumSet.of(READ)));

     // open file for writing to the end of an existing file, creating
     // the file if it doesn't already exist
     WritableByteChannel wbc = Files.newByteChannel(path, EnumSet.of(CREATE,APPEND));

     // create file with initial permissions, opening it for both reading and writing
     FileAttribute<<SetPosixFilePermission>> perms = ...
     SeekableByteChannel sbc = Files.newByteChannel(path, EnumSet.of(CREATE_NEW,READ,WRITE), perms);
 

パラメータ:

path - 開くまたは作成するファイルへのパス

options - ファイルを開く方法を指定するオプション

attrs - ファイルの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

新しいシーク可能なバイトチャネル

例外:

IllegalArgumentException - セットにオプションの無効な組み合わせが含まれる場合

UnsupportedOperationException - 未サポートのオープンオプションが指定された場合またはファイルの作成時に原子的に設定できない属性が配列に含まれる場合

FileAlreadyExistsException - その名前のファイルがすでに存在する場合、および CREATE_NEW オプションが指定された場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、ファイルが読み取り用に開かれると checkRead メソッドが呼び出されてパスへの読み取りアクセスがチェックされます。ファイルが書き込み用に開かれた場合は、checkWrite メソッドが呼び出されてパスへの書き込みアクセスがチェックされます。DELETE_ON_CLOSE オプションでファイルが開かれた場合は、checkDelete メソッドが呼び出されて削除アクセスがチェックされます。

関連項目:

FileChannel.open(Path,Set,FileAttribute[])

newByteChannel

public static SeekableByteChannel newByteChannel(Path path,
                                 OpenOption... options)
                                          throws IOException

ファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。

このメソッドは、newByteChannel メソッドで指定されたとおりにファイルを開くか作成します。

パラメータ:

path - 開くまたは作成するファイルへのパス

options - ファイルを開く方法を指定するオプション

戻り値:

新しいシーク可能なバイトチャネル

例外:

IllegalArgumentException - セットにオプションの無効な組み合わせが含まれる場合

UnsupportedOperationException - サポートされていないオープンオプションが指定された場合

FileAlreadyExistsException - その名前のファイルがすでに存在する場合、および CREATE_NEW オプションが指定された場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、ファイルが読み取り用に開かれると checkRead メソッドが呼び出されてパスへの読み取りアクセスがチェックされます。ファイルが書き込み用に開かれた場合は、checkWrite メソッドが呼び出されてパスへの書き込みアクセスがチェックされます。DELETE_ON_CLOSE オプションでファイルが開かれた場合は、checkDelete メソッドが呼び出されて削除アクセスがチェックされます。

関連項目:

FileChannel.open(Path,OpenOption[])

newDirectoryStream

public static DirectoryStream<Path> newDirectoryStream(Path dir)
                                                throws IOException

ディレクトリを開き、ディレクトリ内のすべてのエントリを反復するための DirectoryStream を返します。ディレクトリストリームの iterator によって返される要素は、Path 型で、それぞれがディレクトリ内のエントリを表します。Path オブジェクトは、dir に対してディレクトリエントリの名前を解決したかのように取得されます。

try-with-resources 構文を使用しない場合は、ディレクトリストリームの close メソッドは、開いているディレクトリのために保持されているリソースを解放するために、反復が完了したあとに呼び出されるべきです。

ディレクトリ内のエントリに対して競合のない方法で実行する操作を実装がサポートする場合は、返されるディレクトリストリームは SecureDirectoryStream です。

パラメータ:

dir - ディレクトリへのパス

戻り値:

新しく開かれた DirectoryStream オブジェクト

例外:

NotDirectoryException - ファイルがディレクトリではないために開けなかった場合 (オプションの固有例外)

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

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

newDirectoryStream

public static DirectoryStream<Path> newDirectoryStream(Path dir,
                                       String glob)
                                                throws IOException

ディレクトリを開き、そのディレクトリ内のエントリに対して反復処理を行う DirectoryStream を返します。ディレクトリストリームの iterator によって返される要素は、Path 型で、それぞれがディレクトリ内のエントリを表します。Path オブジェクトは、dir に対してディレクトリエントリの名前を解決したかのように取得されます。イテレータによって返されるエントリは、そのファイル名の String 表現を指定されたグロッビングパターンと照合することでフィルタ処理されます。

たとえば、ディレクトリ内の「.java」で終わるファイルすべてについて反復処理を行うとします。

     Path dir = ...
     try (DirectoryStream<Path> stream = Files.newDirectoryStream(dir, "*.java")) {
         :
     }
 

グロッビングパターンは、getPathMatcher メソッドによって指定されます。

try-with-resources 構文を使用しない場合は、ディレクトリストリームの close メソッドは、開いているディレクトリのために保持されているリソースを解放するために、反復が完了したあとに呼び出されるべきです。

ディレクトリ内のエントリに対して競合のない方法で実行する操作を実装がサポートする場合は、返されるディレクトリストリームは SecureDirectoryStream です。

パラメータ:

dir - ディレクトリへのパス

glob - glob パターン

戻り値:

新しく開かれた DirectoryStream オブジェクト

例外:

PatternSyntaxException - パターンが無効な場合

NotDirectoryException - ファイルがディレクトリではないために開けなかった場合 (オプションの固有例外)

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

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

newDirectoryStream

public static DirectoryStream<Path> newDirectoryStream(Path dir,
                                       DirectoryStream.Filter<? super Path> filter)
                                                throws IOException

ディレクトリを開き、そのディレクトリ内のエントリに対して反復処理を行う DirectoryStream を返します。ディレクトリストリームの iterator によって返される要素は、Path 型で、それぞれがディレクトリ内のエントリを表します。Path オブジェクトは、dir に対してディレクトリエントリの名前を解決したかのように取得されます。イテレータによって返されるエントリは、指定されたフィルタによってフィルタ処理されます。

try-with-resources 構文を使用しない場合は、ディレクトリストリームの close メソッドは、開いているディレクトリのために保持されているリソースを解放するために、反復が完了したあとに呼び出されるべきです。

キャッチされないエラーまたは実行時例外のためにフィルタが終了した場合は、hasNext または next メソッドにそれが通知されます。IOException がスローされた場合は、その IOException を原因として含む DirectoryIteratorException が hasNext または next メソッドによってスローされます。

ディレクトリ内のエントリに対して競合のない方法で実行する操作を実装がサポートする場合は、返されるディレクトリストリームは SecureDirectoryStream です。

使用例: ディレクトリ内の 8K よりも大きいファイルすべてについて反復処理を行うとします。

     DirectoryStream.Filter<Path> filter = new DirectoryStream.Filter<Path>() {
         public boolean accept(Path file) throws IOException {
             return (Files.size(file) > 8192L);
         }
     };
     Path dir = ...
     try (DirectoryStream<Path> stream = Files.newDirectoryStream(dir, filter)) {
         :
     }
 

パラメータ:

dir - ディレクトリへのパス

filter - ディレクトリストリームフィルタ

戻り値:

新しく開かれた DirectoryStream オブジェクト

例外:

NotDirectoryException - ファイルがディレクトリではないために開けなかった場合 (オプションの固有例外)

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

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

createFile

public static Path createFile(Path path,
              FileAttribute<?>... attrs)
                       throws IOException

新しい空のファイルを作成し、ファイルがすでに存在する場合は失敗します。ファイルがあるかどうかのチェックや、ない場合の新しいファイルの作成は、そのディレクトリに影響を与える可能性のあるほかのすべてのファイルシステムアクティビティーに対して原子的である単一の操作です。

attrs パラメータは、ファイルの作成時に原子的に設定するオプションのファイル属性です。各属性はその name で識別されます。配列に同じ名前の属性が複数含まれる場合は、最後のもの以外はすべて無視されます。

パラメータ:

path - 作成するファイルへのパス

attrs - ファイルの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

ファイル

例外:

UnsupportedOperationException - ファイルの作成時に原子的に設定できない属性が配列に含まれる場合

FileAlreadyExistsException - その名前のファイルがすでに存在する場合 (オプションの固有例外)

IOException - 入出力エラーが発生した場合または親ディレクトリが存在しない場合

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

createDirectory

public static Path createDirectory(Path dir,
                   FileAttribute<?>... attrs)
                            throws IOException

新しいディレクトリを作成します。ファイルがあるかどうかのチェックや、ない場合のディレクトリの作成は、そのディレクトリに影響を与える可能性のあるほかのすべてのファイルシステムアクティビティーに対して原子的である単一の操作です。存在しないすべての親ディレクトリを最初に作成する必要がある場合は、createDirectories メソッドを使用するようにしてください。

attrs パラメータは、ディレクトリの作成時に原子的に設定するオプションのファイル属性です。各属性はその name で識別されます。配列に同じ名前の属性が複数含まれる場合は、最後のもの以外はすべて無視されます。

パラメータ:

dir - 作成するディレクトリ

attrs - ディレクトリの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

ディレクトリ

例外:

UnsupportedOperationException - ディレクトリの作成時に原子的に設定できない属性が配列に含まれる場合

FileAlreadyExistsException - その名前のファイルがすでに存在するためにディレクトリを作成できなかった場合 (オプションの固有例外)

IOException - 入出力エラーが発生した場合または親ディレクトリが存在しない場合

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

createDirectories

public static Path createDirectories(Path dir,
                     FileAttribute<?>... attrs)
                              throws IOException

存在しないすべての親ディレクトリをまず作成することで、ディレクトリを作成します。createDirectory メソッドとは異なり、ディレクトリがすでに存在しているために作成できなかった場合でも例外はスローされません。

attrs パラメータは、存在しないディレクトリの作成時に原子的に設定するオプションのファイル属性です。各ファイル属性はその name で識別されます。配列に同じ名前の属性が複数含まれる場合は、最後のもの以外はすべて無視されます。

このメソッドが失敗する場合は、親ディレクトリの一部 (すべてではない) を作成したあとにそうなることがあります。

パラメータ:

dir - 作成するディレクトリ

attrs - ディレクトリの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

ディレクトリ

例外:

UnsupportedOperationException - ディレクトリの作成時に原子的に設定できない属性が配列に含まれる場合

FileAlreadyExistsException - dir が存在するが、ディレクトリではない場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、ディレクトリの作成を試みる前に checkWrite メソッドが呼び出され、チェックされる親ディレクトリごとに、その checkRead メソッドが呼び出されます。dir が絶対パスでない場合は、その toAbsolutePath を呼び出してその絶対パスを取得することが必要になることがあります。これによって、セキュリティーマネージャーの checkPropertyAccess メソッドが呼び出されて、システムプロパティー user.dir へのアクセスがチェックされることがあります。

createTempFile

public static Path createTempFile(Path dir,
                  String prefix,
                  String suffix,
                  FileAttribute<?>... attrs)
                           throws IOException

指定されたディレクトリで新しい空のファイルを生成し、その名前には、指定された接頭辞および接尾辞の文字列が使用されます。結果の Path は指定されたディレクトリと同じ FileSystem に関連付けられます。

ファイル名の生成方法に関する詳細は、実装に依存しているため、特定できません。可能な場合は、prefix および suffix を使用して、File.createTempFile(String,String,File) メソッドと同じ方法で候補の名前が生成されます。

File.createTempFile メソッドと同様に、このメソッドは一時ファイル機能の一部に過ぎません。作業ファイルとして使用する場合は、結果となるファイルを DELETE_ON_CLOSE オプションを使って開き、適切な close メソッドが呼び出されたときにそのファイルが削除されるようにすることができます。あるいは、shutdown-hook、または File.deleteOnExit() メカニズムを使用してファイルを自動的に削除することもできます。

attrs パラメータは、ファイルの作成時に原子的に設定するオプションのファイル属性です。各属性はその name で識別されます。配列に同じ名前の属性が複数含まれる場合は、最後のもの以外はすべて無視されます。ファイル属性が 1 つも指定されない場合、結果となるファイルは File.createTempFile(String,String,File) メソッドで作成されたファイルよりアクセス権が制限されることがあります。

パラメータ:

dir - ファイルが作成されるディレクトリへのパス

prefix - ファイル名を生成するために使用される接頭辞文字列。次も可能です: null

suffix - ファイル名を生成するために使用される接尾辞文字列。null も指定でき、その場合は、接尾辞 ".tmp" が使用されます。

attrs - ファイルの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

このメソッドの呼び出し前には存在しなかった、新しく作成されたファイルへのパス

例外:

IllegalArgumentException - 候補のファイル名を生成するために prefix または suffix パラメータを使用できない場合

UnsupportedOperationException - ディレクトリの作成時に原子的に設定できない属性が配列に含まれる場合

IOException - 入出力エラーが発生した場合または dir が存在しない場合

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

createTempFile

public static Path createTempFile(String prefix,
                  String suffix,
                  FileAttribute<?>... attrs)
                           throws IOException

指定された接頭辞と接尾辞をファイル名の生成に使用して、デフォルトの一時ファイルディレクトリに空のファイルを生成します。結果の Path はデフォルトの FileSystem に関連付けられています。

このメソッドは、dir パラメータが一時ファイルディレクトリの場合は、createTempFile(Path,String,String,FileAttribute[]) メソッドによって指定されたとおりに機能します。

パラメータ:

prefix - ファイル名を生成するために使用される接頭辞文字列。次も可能です: null

suffix - ファイル名を生成するために使用される接尾辞文字列。null も指定でき、その場合は、接尾辞 ".tmp" が使用されます。

attrs - ファイルの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

このメソッドの呼び出し前には存在しなかった、新しく作成されたファイルへのパス

例外:

IllegalArgumentException - 候補のファイル名を生成するために prefix または suffix パラメータを使用できない場合

UnsupportedOperationException - ディレクトリの作成時に原子的に設定できない属性が配列に含まれる場合

IOException - 入出力エラーが発生した場合または一時ファイルディレクトリが存在しない場合

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

createTempDirectory

public static Path createTempDirectory(Path dir,
                       String prefix,
                       FileAttribute<?>... attrs)
                                throws IOException

指定されたディレクトリで新しいディレクトリを生成し、その名前には、指定された接頭辞が使用されます。結果の Path は指定されたディレクトリと同じ FileSystem に関連付けられます。

ディレクトリ名の生成方法に関する詳細は、実装に依存しているため、特定できません。可能な場合は、prefix を使用して候補の名前が生成されます。

createTempFile メソッドと同様に、このメソッドは一時ファイル機能の一部に過ぎません。shutdown-hook、または File.deleteOnExit() メカニズムを使用すると、ディレクトリを自動的に削除できます。

attrs パラメータは、ディレクトリの作成時に原子的に設定するオプションのファイル属性です。各属性はその name で識別されます。配列に同じ名前の属性が複数含まれる場合は、最後のもの以外はすべて無視されます。

パラメータ:

dir - ディレクトリが作成されるディレクトリへのパス

prefix - ディレクトリ名を生成するために使用される接頭辞文字列。次も可能です: null

attrs - ディレクトリの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

このメソッドの呼び出し前には存在しなかった、新しく作成されたディレクトリへのパス

例外:

IllegalArgumentException - 候補のディレクトリ名を生成するために prefix を使用できない場合

UnsupportedOperationException - ディレクトリの作成時に原子的に設定できない属性が配列に含まれる場合

IOException - 入出力エラーが発生した場合または dir が存在しない場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、ディレクトリの作成時に checkWrite メソッドが呼び出されて書き込みアクセスがチェックされます。

createTempDirectory

public static Path createTempDirectory(String prefix,
                       FileAttribute<?>... attrs)
                                throws IOException

デフォルトの一時ファイルディレクトリで新しいディレクトリを生成し、その名前には、指定された接頭辞が使用されます。結果の Path はデフォルトの FileSystem に関連付けられています。

このメソッドは、dir パラメータが一時ファイルディレクトリの場合は、createTempDirectory(Path,String,FileAttribute[]) メソッドによって指定されたとおりに機能します。

パラメータ:

prefix - ディレクトリ名を生成するために使用される接頭辞文字列。次も可能です: null

attrs - ディレクトリの作成時に原子的に設定されるファイル属性のオプションのリスト

戻り値:

このメソッドの呼び出し前には存在しなかった、新しく作成されたディレクトリへのパス

例外:

IllegalArgumentException - 候補のディレクトリ名を生成するために prefix を使用できない場合

UnsupportedOperationException - ディレクトリの作成時に原子的に設定できない属性が配列に含まれる場合

IOException - 入出力エラーが発生した場合または一時ファイルディレクトリが存在しない場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、ディレクトリの作成時に checkWrite メソッドが呼び出されて書き込みアクセスがチェックされます。

createSymbolicLink

public static Path createSymbolicLink(Path link,
                      Path target,
                      FileAttribute<?>... attrs)
                               throws IOException

ターゲットへのシンボリックリンクを作成します (オプションの操作)。

target パラメータは、そのリンクのターゲットです。それは絶対または相対パスにすることができ、存在しないこともあります。ターゲットが相対パスである場合、結果となるリンクに対するファイルシステム操作は、そのリンクのパスを基準にして行われます。

attrs パラメータは、リンクの作成時に原子的に設定するオプションの属性です。各属性はその name で識別されます。配列に同じ名前の属性が複数含まれる場合は、最後のもの以外はすべて無視されます。

シンボリックリンクがサポートされているが、ベースとなる FileStore がシンボリックリンクをサポートしていない場合、これは IOException で失敗することがあります。また、一部のオペレーティングシステムではシンボリックリンクを作成するために Java 仮想マシンを実装固有の特権で起動することが必要なことがあり、その場合はこのメソッドによって IOException がスローされることがあります。

パラメータ:

link - 作成するシンボリックリンクへのパス

target - シンボリックリンクのターゲット

attrs - シンボリックリンクの作成時に原子的に設定される属性の配列

戻り値:

シンボリックリンクへのパス

例外:

UnsupportedOperationException - 実装がシンボリックリンクをサポートしない場合、またはシンボリックリンクの作成時に原子的に設定できない属性が配列に含まれる場合

FileAlreadyExistsException - その名前のファイルがすでに存在する場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、それが LinkPermission("symbolic") を拒否するか、またはその checkWrite メソッドがシンボリックリンクのパスへの書き込みアクセスを拒否する場合。

createLink

public static Path createLink(Path link,
              Path existing)
                       throws IOException

既存のファイルに対して新しいリンク (ディレクトリエントリ) を作成します (オプションの操作)。

link パラメータは、作成するディレクトリエントリを検出します。existing パラメータは、既存のファイルへのパスです。このメソッドは、そのファイルの新しいディレクトリエントリを作成することで、link をパスとして使用してそれにアクセスできるようにします。一部のファイルシステムでは、これは「ハードリンク」の作成として知られています。ファイル属性がそのファイルのために保持されるか、またはディレクトリエントリごとに保持されるかは、ファイルシステムに固有であるため、特定できません。通常、ファイルシステムでは、1 つのファイルのすべてのリンク (ディレクトリエントリ) が同じファイルシステム上にある必要があります。さらに、一部のプラットフォームでは、ハードリンクを作成するか、ディレクトリへのリンクを作成するために Java 仮想マシンを実装固有の特権で起動することが必要な場合もあります。

パラメータ:

link - 作成するリンク (ディレクトリエントリ)

existing - 既存のファイルへのパス

戻り値:

リンク (ディレクトリエントリ) へのパス

例外:

UnsupportedOperationException - 実装が、既存のファイルをディレクトリに追加することをサポートしない場合

FileAlreadyExistsException - その名前のファイルがすでに存在するためにエントリを作成できなかった場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、それが LinkPermission("hard") を拒否するか、またはその checkWrite メソッドがリンクまたは既存のファイルへの書き込みアクセスを拒否する場合。

delete

public static void delete(Path path)
                   throws IOException

ファイルを削除します。

実装では、ファイルがディレクトリかどうかを判断するためにファイルを検査することが必要な場合があります。その結果、このメソッドはほかのファイルシステム操作に関して原始的でない可能性があります。ファイルがシンボリックリンクの場合、そのリンクの最終ターゲットではなく、そのシンボリックリンク自体が削除されます。

ファイルがディレクトリの場合、ディレクトリは空である必要があります。一部の実装では、ディレクトリの作成時に作成される特殊なファイルやリンクのエントリがディレクトリに存在します。このような実装では、ディレクトリは特殊なエントリのみが存在する場合に空であるとみなされます。このメソッドを walkFileTree メソッドとともに使用すると、必要に応じてディレクトリとそのディレクトリ内のすべてのエントリを削除したり、ファイルツリー全体を削除したりすることができます。

一部のオペレーシングシステムでは、この Java 仮想マシンまたはほかのプログラムによって開かれて使用されているファイルを削除できない場合があります。

パラメータ:

path - 削除するファイルへのパス

例外:

NoSuchFileException - ファイルが存在しない場合 (オプションの固有例外)

DirectoryNotEmptyException - ファイルがディレクトリで、ディレクトリが空でないために削除できなかった場合 (オプションの固有例外)

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

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

deleteIfExists

public static boolean deleteIfExists(Path path)
                              throws IOException

ファイルが存在する場合は削除します。

delete(Path) メソッドと同様に、実装では、ファイルがディレクトリかどうかを判断するためにファイルを検査することが必要な場合があります。その結果、このメソッドはほかのファイルシステム操作に関して原始的でない可能性があります。ファイルがシンボリックリンクの場合、そのリンクの最終ターゲットではなく、そのシンボリックリンク自体が削除されます。

ファイルがディレクトリの場合、ディレクトリは空である必要があります。一部の実装では、ディレクトリの作成時に作成される特殊なファイルやリンクのエントリがディレクトリに存在します。このような実装では、ディレクトリは特殊なエントリのみが存在する場合に空であるとみなされます。

一部のオペレーシングシステムでは、この Java 仮想マシンまたはほかのプログラムによって開かれて使用されているファイルを削除できない場合があります。

パラメータ:

path - 削除するファイルへのパス

戻り値:

ファイルがこのメソッドによって削除された場合は true、ファイルが存在しないために削除できなかった場合は false

例外:

DirectoryNotEmptyException - ファイルがディレクトリで、ディレクトリが空でないために削除できなかった場合 (オプションの固有例外)

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

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

copy

public static Path copy(Path source,
        Path target,
        CopyOption... options)
                 throws IOException

ファイルをターゲットファイルにコピーします。

このメソッドは、コピーの実行方法を指定する options パラメータを使って、ファイルをターゲットファイルにコピーします。デフォルトでは、ソースとターゲットが同じファイルである場合を除き (その場合、このメソッドはファイルをコピーしないで終了する)、ターゲットファイルがすでに存在するか、シンボリックリンクである場合にそのコピーは失敗します。ファイル属性がターゲットファイルにコピーされる必要ありません。シンボリックリンクがサポートされていて、ファイルがシンボリックリンクである場合、そのリンクの最終ターゲットがコピーされます。ファイルがディレクトリである場合、空のディレクトリがターゲットの場所に作成されます (そのディレクトリ内のエントリはコピーされない)。このメソッドを walkFileTree メソッドとともに使用すると、必要に応じてディレクトリとそのディレクトリ内のすべてのエントリをコピーしたり、ファイルツリー全体をコピーしたりすることができます。

options パラメータには次のものを含めることができます。

オプション	説明
REPLACE_EXISTING	ターゲットファイルが存在する場合は、ターゲットファイルが空でないディレクトリでなければ置換されます。ターゲットファイルが存在してシンボリックリンクである場合は、リンクのターゲットではなくシンボリックリンク自身が置換されます。
COPY_ATTRIBUTES	このファイルに関連付けられたファイル属性をターゲットファイルにコピーしようとします。コピーされる正確なファイル属性はプラットフォームやファイルシステムに依存しているため、特定できません。少なくとも、最終更新時間はターゲットファイルにコピーされます (ソースとターゲットの両方のファイルストアでサポートされている場合)。ファイルのタイムスタンプをコピーすると、精度が失われる可能性があります。
NOFOLLOW_LINKS	シンボリックリンクはたどられません。ファイルがシンボリックリンクの場合、そのリンクのターゲットではなく、そのシンボリックリンク自体がコピーされます。ファイル属性を新しいリンクにコピーできるかどうかは実装に固有です。つまり、シンボリックリンクをコピーする場合は COPY_ATTRIBUTES オプションが無視される可能性があります。

このインタフェースの実装は、追加の実装固有オプションをサポートできます。

ファイルのコピーは、原子的操作ではありません。IOException がスローされる場合は、ターゲットファイルが不完全であるか、またはそのファイル属性の一部がソースファイルからコピーされていない可能性があります。REPLACE_EXISTING オプションが指定され、ターゲットファイルが存在する場合は、ターゲットファイルが置換されます。ファイルがあるかどうかのチェックや新しいファイルの作成は、ほかのファイルシステムアクティビティーに対して原子的でない可能性があります。

使用例: ファイルをディレクトリ内にコピーして、そのファイル名をソースファイルと同じに名前にするとします。

     Path source = ...
     Path newdir = ...
     Files.copy(source, newdir.resolve(source.getFileName());
 

パラメータ:

source - コピーするファイルへのパス

target - ターゲットファイルへのパス (ソースパスとは異なるプロバイダに関連付けられている場合がある)

options - コピーをどのように実行するべきかを指定するオプション

戻り値:

ターゲットファイルへのパス

例外:

UnsupportedOperationException - サポートされないコピーオプションが配列に含まれる場合

FileAlreadyExistsException - ターゲットファイルは存在するけれども、REPLACE_EXISTING オプションが指定されていないために置換できない場合 (オプションの固有例外)

DirectoryNotEmptyException - REPLACE_EXISTING オプションが指定されているけれども、空でないディレクトリであるために置換できない場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkRead メソッドが呼び出されてソースファイルへの読み取りアクセスがチェックされ、checkWrite メソッドが呼び出されてターゲットファイルへの書き込みアクセスがチェックされます。シンボリックリンクがコピーされる場合は、セキュリティーマネージャーが呼び出されて LinkPermission("symbolic") がチェックされます。

move

public static Path move(Path source,
        Path target,
        CopyOption... options)
                 throws IOException

ファイルをターゲットファイルに移動するか、そのファイル名を変更します。

デフォルトでは、このメソッドはターゲットファイルへのファイルの移動を試み、ソースとターゲットが同じファイルである場合を除き (その場合、このメソッドは何の効果もない)、ターゲットファイルが存在する場合は失敗します。ファイルがシンボリックリンクの場合、そのリンクのターゲットではなく、そのシンボリックリンク自体が移動されます。このメソッドは空のディレクトリを移動するために呼び出すこともできます。一部の実装では、ディレクトリの作成時に作成される特殊なファイルやリンクのエントリがディレクトリに存在します。このような実装では、ディレクトリは特殊なエントリのみが存在する場合に空であるとみなされます。空でないディレクトリを移動するために呼び出すと、そのディレクトリ内のエントリを移動する必要がない場合にそのディレクトリが移動されます。たとえば、同じ FileStore 上にあるディレクトリの名前を変更する場合、通常はそのディレクトリ内のエントリを移動する必要はありません。ディレクトリを移動するときにそのエントリも移動する必要がある場合、このメソッドは失敗します (IOException をスローする)。ファイルツリーを移動する場合は、ディレクトリの移動ではなくコピーが必要になることがあり、これを行うには、copy メソッドを Files.walkFileTree ユーティリティーメソッドと組み合わせて使用します。

options パラメータには次のものを含めることができます。

オプション	説明
REPLACE_EXISTING	ターゲットファイルが存在する場合は、ターゲットファイルが空でないディレクトリでなければ置換されます。ターゲットファイルが存在してシンボリックリンクである場合は、リンクのターゲットではなくシンボリックリンク自身が置換されます。
ATOMIC_MOVE	この移動は原子的なファイルシステム操作として実行され、他のオプションはすべて無視されます。ターゲットファイルが存在する場合、その既存ファイルが置換されるか、またはこのメソッドが IOException をスローして失敗するかは実装に固有です。移動を原子的なファイルシステム操作として実行できない場合は、AtomicMoveNotSupportedException がスローされます。これは、ターゲットの場所が異なる FileStore 上にあるときにファイルをコピーする必要があったり、ターゲットの場所がこのオブジェクトとは異なるプロバイダに関連付けられていたりする場合などに発生することがあります。

このインタフェースの実装は、追加の実装固有オプションをサポートできます。

移動のときにファイルをコピーする必要がある場合は、最終変更時間が新しいファイルにコピーされます。実装では、他のファイル属性のコピーも試みることができますが、それらのファイル属性をコピーできない場合に必ずしも失敗するとはかぎりません。移動を原子的でない操作として実行し、IOException がスローされる場合、ファイルの状態は特定できません。元のファイルとターゲットファイルの両方が存在したり、ターゲットファイルが不完全であったり、そのファイル属性の一部が元のファイルからコピーされていなかったりする可能性があります。

使用例: ファイルの名前を「newname」に変更して、そのファイルを同じディレクトリに保存するとします。

     Path source = ...
     Files.move(source, source.resolveSibling("newname"));
 

あるいは、ファイルを新しいディレクトリに移動して、同じファイル名を保持し、ディレクトリ内にその名前の既存ファイルがあれば置換するとします。

     Path source = ...
     Path newdir = ...
     Files.move(source, newdir.resolve(source.getFileName()), REPLACE_EXISTING);
 

パラメータ:

source - 移動するファイルへのパス

target - ターゲットファイルへのパス (ソースパスとは異なるプロバイダに関連付けられている場合がある)

options - 移動をどのように実行するべきかを指定するオプション

戻り値:

ターゲットファイルへのパス

例外:

UnsupportedOperationException - サポートされないコピーオプションが配列に含まれる場合

FileAlreadyExistsException - ターゲットファイルは存在するけれども、REPLACE_EXISTING オプションが指定されていないために置換できない場合 (オプションの固有例外)

DirectoryNotEmptyException - REPLACE_EXISTING オプションが指定されているけれども、空でないディレクトリであるために置換できない場合 (オプションの固有例外)

AtomicMoveNotSupportedException - オプション配列に ATOMIC_MOVE オプションを含まれるけれども、原子的なファイルシステム操作としてファイルを移動できない場合。

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkWrite メソッドが呼び出されてソースおよびターゲットファイルの両方への書き込みアクセスがチェックされます。

readSymbolicLink

public static Path readSymbolicLink(Path link)
                             throws IOException

シンボリックリンクのターゲットを読み取ります (オプションの操作)。

ファイルシステムがシンボリックリンクをサポートしている場合、このメソッドはそのリンクのターゲットを読み取るために使用され、ファイルがシンボリックリンクでない場合は失敗します。そのリンクのターゲットは存在しなくてもかまいません。返される Path オブジェクトは、link と同じファイルシステムに関連付けられます。

パラメータ:

link - シンボリックリンクへのパス

戻り値:

そのリンクのターゲットを表す Path オブジェクト

例外:

UnsupportedOperationException - この実装がシンボリックリンクをサポートしていない場合。

NotLinkException - ファイルがシンボリックリンクではないためにターゲットを読み取れなかった場合 (オプションの固有例外)

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、リンクを読み取る "readlink" アクションに FilePermission が付与されていることがチェックされます。

getFileStore

public static FileStore getFileStore(Path path)
                              throws IOException

ファイルが置かれているファイルストアを表す FileStore を返します。

FileStore への参照が取得されると、返された FileStore に対する操作や、そこから取得される FileStoreAttributeView オブジェクトが引き続きそのファイルの存在に左右されるのかどうかは実装に固有です。特に、ファイルが削除されたり、別のファイルストアに移動されたりする場合では、この動作を特定できません。

パラメータ:

path - ファイルへのパス

戻り値:

ファイルが格納されるファイルストア

例外:

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

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

isSameFile

public static boolean isSameFile(Path path,
                 Path path2)
                          throws IOException

2 つのパスが同じファイルを検出するかどうかを判断します。

両方の Path オブジェクトが等しい場合、このメソッドはファイルが存在するかどうかを判定せずに true を返します。2 つの Path オブジェクトが別々のプロバイダに関連付けられている場合、このメソッドは false を返します。それ以外の場合、このメソッドは両方の Path オブジェクトが同じファイルを検出するかどうかを判定し、実装によっては、両方のファイルを開くか、それにアクセスすることが必要になる場合があります。

ファイルシステムやファイルが static のままである場合、このメソッドは null 以外の Path に対して同値関係を実装します。

• 反射性 (reflexive): パス f について、isSameFile(f,f) は true を返します。
• 対称性 (symmetric): 2 つのパス f および g について、isSameFile(f,g) は isSameFile(g,f) と同等です。
• 推移性 (transitive): 3 つのパス f、g、および h について、isSameFile(f,g) が true を返し、isSameFile(g,h) が true を返す場合、isSameFile(g,h) は true を返します。

パラメータ:

path - ファイルへの一方のパス

path2 - もう一方のパス

戻り値:

2 つのパスが同じファイルを検出する場合にのみ true

例外:

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

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

関連項目:

BasicFileAttributes.fileKey()

isHidden

public static boolean isHidden(Path path)
                        throws IOException

ファイルが隠しファイルとみなされるかどうかを判断します。「隠し」の正確な定義はプラットフォームまたはプロバイダに依存します。たとえば、UNIX では、ファイル名がピリオド (「.」) で始まるファイルが隠しファイルとみなされます。Windows では、ディレクトリでなく、DOS の hidden 属性が設定されているファイルが隠しファイルとみなされます。

実装によっては、このメソッドは、ファイルが隠しファイルとみなされるかどうかを判断するためにファイルシステムにアクセスすることが必要になる場合があります。

パラメータ:

path - テストするファイルへのパス

戻り値:

ファイルが隠しとみなされる場合 true

例外:

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

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

probeContentType

public static String probeContentType(Path path)
                               throws IOException

ファイルのコンテンツタイプを調べます。

このメソッドは、インストールされている FileTypeDetector の実装を使用して、指定されたファイルを調査し、そのコンテンツタイプを特定します。各ファイルタイプディテクタの probeContentType が順番に呼び出されて、ファイルタイプが調査されます。ファイルが認識される場合は、コンテンツタイプが返されます。インストールされているどのファイルタイプディテクタによってもファイルが認識されない場合は、システムデフォルトのファイルタイプディテクタが呼び出されてコンテンツタイプが推測されます。

Java 仮想マシンのある特定の呼び出しで、システム全体のファイルタイプディテクタリストが保持されます。インストールされているファイルタイプディテクタのロードには、ServiceLoader クラスで定義されているサービスプロバイダのロード機能が使用されます。インストールされているファイルタイプディテクタのロードにはシステムクラスローダーが使用されます。システムクラスローダーが見つからない場合は拡張クラスローダーが使用され、拡張クラスローダーが見つからない場合はブートストラップクラスローダーが使用されます。通常、インストールされるファイルタイプディテクタはアプリケーションクラスパス上の JAR ファイルまたは拡張ディレクトリ内に配置されます。その JAR ファイルのリソースディレクトリ META-INF/services には java.nio.file.spi.FileTypeDetector というプロバイダ構成ファイルが含まれており、そのファイルには引数なしのコンストラクタを持つ FileTypeDetector の具象サブクラスの 1 つまたは複数の完全修飾名が一覧表示されます。インストールされているファイルタイプディテクタの検索またはインスタンス化のプロセスが失敗すると、特定できないエラーがスローされます。インストールされているプロバイダの検索順序は実装によって異なります。

このメソッドの戻り値は、RFC 2045「MIME (Multipurpose Internet Mail Extensions) のパート 1: インターネットメッセージ本文の形式」で定義されている、MIME (Multipurpose Internet Mail Extension) コンテンツタイプの文字列形式の値になります。この文字列は、RFC の文法に従って構文解析可能であることが保証されています。

パラメータ:

path - 調査するファイルへのパス

戻り値:

ファイルのコンテンツタイプ。コンテンツタイプを特定できない場合は null

例外:

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

SecurityException - セキュリティーマネージャーがインストールされ、それがファイルタイプディテクタ実装に必要な未指定のアクセス権を拒否する場合。

getFileAttributeView

public static <V extends FileAttributeView> V getFileAttributeView(Path path,
                                                   Class<V> type,
                                                   LinkOption... options)

指定されたタイプのファイル属性ビューを返します。

ファイル属性ビューは、一連のファイル属性の読み取り専用または更新可能なビューを提供します。このメソッドは、ファイル属性の読み取りや更新を行うための型保証されたメソッドをファイル属性ビューで定義する場合に使用するよう意図されています。type パラメータは必要な属性ビューのタイプで、メソッドはサポートされている場合はそのタイプのインスタンスを返します。BasicFileAttributeView タイプは、ファイルの基本属性へのアクセスをサポートします。このメソッドを呼び出して、そのタイプのファイル属性ビューを選択すると、常にそのクラスのインスタンスが返されます。

options 配列を使用すると、ファイルがシンボリックリンクである場合の、結果となるファイル属性ビューによるシンボリックリンクの処理方法を指定できます。デフォルトではシンボリックリンクはたどられます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。シンボリックリンクをサポートしない実装では、このオプションは無視されます。

使用例: ファイルの ACL (サポートされている場合) の読み取りまたは設定を行うとします。

     Path path = ...
     AclFileAttributeView view = Files.getFileAttributeView(path, AclFileAttributeView.class);
     if (view != null) {
         List<AclEntry> acl = view.getAcl();
         :
     }
 

パラメータ:

path - ファイルへのパス

type - ファイル属性ビューに対応する Class オブジェクト

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

戻り値:

指定されたタイプのファイル属性ビュー、または属性ビューのタイプがない場合は null

readAttributes

public static <A extends BasicFileAttributes> A readAttributes(Path path,
                                               Class<A> type,
                                               LinkOption... options)
                                                    throws IOException

一括操作としてファイル属性を読み取ります。

type パラメータは必要な属性のタイプで、このメソッドではそのタイプがサポートされている場合にそのインスタンスを返します。すべての実装でファイル属性の基本セットがサポートされているため、このメソッドを BasicFileAttributes.class という type パラメータで呼び出した場合、UnsupportedOperationException はスローされません。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはたどられ、リンクの最終ターゲットのファイル属性が読み取られます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

ほかのファイルシステム操作に関して、すべてのファイル属性が原子的操作として読み取られるかどうかは実装固有です。

使用例: ファイルの属性を一括して読み取るとします。

    Path path = ...
    BasicFileAttributes attrs = Files.readAttributes(path, BasicFileAttributes.class);
 

あるいは、シンボリックリンクをたどらずにファイルの POSIX 属性を読み取るとします。

    PosixFileAttributes attrs = Files.readAttributes(path, PosixFileAttributes.class, NOFOLLOW_LINKS);
 

パラメータ:

path - ファイルへのパス

type - 読み取る必要のあるファイル属性の Class

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

戻り値:

ファイル属性

例外:

UnsupportedOperationException - 指定されたタイプの属性がサポートされない場合

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkRead メソッドが呼び出されてファイルへの読み取りアクセスがチェックされます。このメソッドが、セキュリティー保護を必要とする属性を読み取るために呼び出された場合、セキュリティーマネージャーが呼び出されて追加のアクセス権をチェックする場合があります。

setAttribute

public static Path setAttribute(Path path,
                String attribute,
                Object value,
                LinkOption... options)
                         throws IOException

ファイル属性の値を設定します。

attribute パラメータは、設定する属性を識別し、次の形式をとります。

[view-name:]attribute-name

ここで、角括弧 [...] は省略可能なコンポーネントを表し、文字 ':' はそれ自体を表します。

view-name は、ファイル属性のセットを指定する、FileAttributeView の name です。これを指定しない場合は、デフォルトで "basic" (多くのファイルシステムに共通するファイル属性の基本セットを識別するファイル属性ビューの名前) になります。attribute-name はそのセット内の属性の名前です。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクがたどられ、そのリンクの最終ターゲットのファイル属性が設定されます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

使用例: DOS の「hidden」属性を設定するとします。

    Path path = ...
    Files.setAttribute(path, "dos:hidden", true);
 

パラメータ:

path - ファイルへのパス

attribute - 設定する属性

value - 属性値

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

戻り値:

path パラメータ

例外:

UnsupportedOperationException - 属性ビューが使用できない場合

IllegalArgumentException - 属性名が指定されない場合、または認識されない場合、または属性値の型は正しいが値が不適切な場合

ClassCastException - 属性値が予想される型でないか、予想される型でない要素を含むコレクションである場合

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、その checkWrite メソッドがファイルへの書き込みアクセスを拒否する場合。このメソッドが、セキュリティー保護を必要とする属性を設定するために呼び出された場合、セキュリティーマネージャーが呼び出されて追加のアクセス権をチェックする場合があります。

getAttribute

public static Object getAttribute(Path path,
                  String attribute,
                  LinkOption... options)
                           throws IOException

ファイル属性の値を読み取ります。

attribute パラメータは、読み取る属性を指定し、次の形式をとります。

[view-name:]attribute-name

ここで、角括弧 [...] は省略可能なコンポーネントを表し、文字 ':' はそれ自体を表します。

view-name は、ファイル属性のセットを指定する、FileAttributeView の name です。これを指定しない場合は、デフォルトで "basic" (多くのファイルシステムに共通するファイル属性の基本セットを識別するファイル属性ビューの名前) になります。attribute-name は属性の名前です。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはたどられ、リンクの最終ターゲットのファイル属性が読み取られます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

使用例: 「unix」ビューをサポートするシステム上のファイル所有者のユーザー ID を要求するとします。

    Path path = ...
    int uid = (Integer)Files.getAttribute(path, "unix:uid");
 

パラメータ:

path - ファイルへのパス

attribute - 読み取る属性

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

戻り値:

属性値

例外:

UnsupportedOperationException - 属性ビューが使用できない場合

IllegalArgumentException - 属性名が指定されていないか、認識されない場合

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、その checkRead メソッドがファイルへの読み取りアクセスを拒否する場合。このメソッドが、セキュリティー保護を必要とする属性を読み取るために呼び出された場合、セキュリティーマネージャーが呼び出されて追加のアクセス権をチェックする場合があります。

readAttributes

public static Map<String,Object> readAttributes(Path path,
                                String attributes,
                                LinkOption... options)
                                         throws IOException

一括操作として一連のファイル属性を読み取ります。

attributes パラメータは、読み取る属性を識別し、次の形式をとります。

[view-name:]attribute-list

ここで、角括弧 [...] は省略可能なコンポーネントを表し、文字 ':' はそれ自体を表します。

view-name は、ファイル属性のセットを指定する、FileAttributeView の name です。これを指定しない場合は、デフォルトで "basic" (多くのファイルシステムに共通するファイル属性の基本セットを識別するファイル属性ビューの名前) になります。

attribute-list コンポーネントは、0 個以上の読み取る属性の名前の、コンマで区切られたリストです。このリストに値 "*" が含まれている場合は、すべての属性が読み取られます。サポートされていない属性は無視され、返されるマップには含まれません。ほかのファイルシステム操作に関して、すべての属性が原子的操作として読み取られるかどうかは実装固有です。

次の例は、attributes パラメータの使用可能な値を示しています。

"*"	すべての基本ファイル属性を読み取ります。
"size,lastModifiedTime,lastAccessTime"	ファイルサイズ、最終更新時間、および最終アクセス時間の属性を読み取ります。
"posix:*"	すべての POSIX-file-attributes を読み取ります。
"posix:permissions,owner,size"	POSIX ファイルアクセス権、所有者、およびファイルサイズを読み取ります。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはたどられ、リンクの最終ターゲットのファイル属性が読み取られます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

パラメータ:

path - ファイルへのパス

attributes - 読み取る属性

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

戻り値:

返される属性のマップ。マップのキーは属性名で、その値は属性値である

例外:

UnsupportedOperationException - 属性ビューが使用できない場合

IllegalArgumentException - 属性が指定されない場合または認識されない属性が指定された場合

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、その checkRead メソッドがファイルへの読み取りアクセスを拒否する場合。このメソッドが、セキュリティー保護を必要とする属性を読み取るために呼び出された場合、セキュリティーマネージャーが呼び出されて追加のアクセス権をチェックする場合があります。

getPosixFilePermissions

public static Set<PosixFilePermission> getPosixFilePermissions(Path path,
                                               LinkOption... options)
                                                        throws IOException

ファイルの POSIX ファイルアクセス権を返します。

path パラメータは、PosixFileAttributeView をサポートする FileSystem に関連付けられます。この属性ビューは、Portable Operating System Interface (POSIX) の標準ファミリを実装するオペレーティングシステムによって使用されるファイルシステムのファイルに一般的に関連付けられるファイル属性へのアクセスを提供します。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはたどられ、リンクの最終ターゲットのファイル属性が読み取られます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

パラメータ:

path - ファイルへのパス

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

戻り値:

ファイルアクセス権

例外:

UnsupportedOperationException - 関連付けられるファイルシステムが次をサポートしない場合: PosixFileAttributeView

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、それが RuntimePermission("accessUserInformation") を拒否するか、またはその checkRead メソッドがファイルへの読み取りアクセスを拒否する場合。

setPosixFilePermissions

public static Path setPosixFilePermissions(Path path,
                           Set<PosixFilePermission> perms)
                                    throws IOException

ファイルの POSIX ファイルアクセス権を設定します。

path パラメータは、PosixFileAttributeView をサポートする FileSystem に関連付けられます。この属性ビューは、Portable Operating System Interface (POSIX) の標準ファミリを実装するオペレーティングシステムによって使用されるファイルシステムのファイルに一般的に関連付けられるファイル属性へのアクセスを提供します。

パラメータ:

path - ファイルを識別するファイル参照

perms - アクセス権の新しいセット

例外:

UnsupportedOperationException - 関連付けられるファイルシステムが次をサポートしない場合: PosixFileAttributeView

ClassCastException - セットに次のタイプでない要素が含まれる場合: PosixFilePermission

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、それが RuntimePermission("accessUserInformation") を拒否するか、またはその checkWrite メソッドがファイルへの書き込みアクセスを拒否する場合。

getOwner

public static UserPrincipal getOwner(Path path,
                     LinkOption... options)
                              throws IOException

ファイルの所有者を返します。

path パラメータは、FileOwnerAttributeView をサポートするファイルシステムに関連付けられます。このファイル属性ビューは、ファイルの所有者であるファイル属性へのアクセスを提供します。

パラメータ:

path - ファイルを識別するファイル参照

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

戻り値:

ファイルの所有者を表すユーザー主体

例外:

UnsupportedOperationException - 関連付けられるファイルシステムが次をサポートしない場合: FileOwnerAttributeView

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、それが RuntimePermission("accessUserInformation") を拒否するか、またはその checkRead メソッドがファイルへの読み取りアクセスを拒否する場合。

setOwner

public static Path setOwner(Path path,
            UserPrincipal owner)
                     throws IOException

ファイル所有者を更新します。

path パラメータは、FileOwnerAttributeView をサポートするファイルシステムに関連付けられます。このファイル属性ビューは、ファイルの所有者であるファイル属性へのアクセスを提供します。

使用例: "joe" をファイルの所有者にするとします。

     Path path = ...
     UserPrincipalLookupService lookupService =
         provider(path).getUserPrincipalLookupService();
     UserPrincipal joe = lookupService.lookupPrincipalByName("joe");
     Files.setOwner(path, joe);
 

パラメータ:

path - ファイルを識別するファイル参照

owner - 新しいファイル所有者

例外:

UnsupportedOperationException - 関連付けられるファイルシステムが次をサポートしない場合: FileOwnerAttributeView

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

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされていて、それが RuntimePermission("accessUserInformation") を拒否するか、またはその checkWrite メソッドがファイルへの書き込みアクセスを拒否する場合。

関連項目:

FileSystem.getUserPrincipalLookupService(), UserPrincipalLookupService

isSymbolicLink

public static boolean isSymbolicLink(Path path)

ファイルがシンボリックリンクかどうかをテストします。

入出力例外を、ファイルがシンボリックリンクでないケースと区別する必要がある場合は、readAttributes メソッドを使ってファイル属性を読み取ったり、BasicFileAttributes.isSymbolicLink() メソッドを使ってファイルタイプを判定したりできます。

戻り値:

ファイルがシンボリックリンクである場合は true。ファイルが存在しないか、シンボリックリンクでないか、またはファイルがシンボリックリンクかどうかを判断できない場合は false。

例外:

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

isDirectory

public static boolean isDirectory(Path path,
                  LinkOption... options)

ファイルがディレクトリかどうかをテストします。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはたどられ、リンクの最終ターゲットのファイル属性が読み取られます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

入出力例外を、ファイルがディレクトリでないケースと区別する必要がある場合は、readAttributes メソッドを使ってファイル属性を読み取ったり、BasicFileAttributes.isDirectory() メソッドを使ってファイルタイプを判定したりできます。

パラメータ:

path - テストするファイルへのパス

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

戻り値:

ファイルがディレクトリである場合は true。ファイルが存在しないか、ディレクトリでないか、またはファイルがディレクトリかどうかを判断できない場合は false。

例外:

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

isRegularFile

public static boolean isRegularFile(Path path,
                    LinkOption... options)

ファイルが不透明な内容の通常ファイルかどうかをテストします。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはたどられ、リンクの最終ターゲットのファイル属性が読み取られます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

入出力例外を、ファイルが通常ファイルでないケースと区別する必要がある場合は、readAttributes メソッドを使ってファイル属性を読み取ったり、BasicFileAttributes.isRegularFile() メソッドを使ってファイルタイプを判定したりできます。

パラメータ:

path - ファイルへのパス

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

戻り値:

ファイルが通常ファイルである場合は true。ファイルが存在しないか、通常ファイルでないか、またはファイルが通常ファイルかどうかを判断できない場合は false。

例外:

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

getLastModifiedTime

public static FileTime getLastModifiedTime(Path path,
                           LinkOption... options)
                                    throws IOException

ファイルの最終変更時間を返します。

options 配列を使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトでは、シンボリックリンクはたどられ、リンクの最終ターゲットのファイル属性が読み取られます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

パラメータ:

path - ファイルへのパス

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

戻り値:

ファイルが最後に変更された時間を表す FileTime。最終変更時間を示すタイムスタンプがそのファイルシステムによってサポートされていない場合は実装固有のデフォルト

例外:

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

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

関連項目:

BasicFileAttributes.lastModifiedTime()

setLastModifiedTime

public static Path setLastModifiedTime(Path path,
                       FileTime time)
                                throws IOException

ファイルの最終変更時間属性を更新します。ファイル時間は、そのファイルシステムでサポートされている元期と精度に変換されます。粒度の細かいほうから粗いほうへ変換すると、精度が失われます。最終変更時間がそのファイルシステムによってサポートされていない場合、またはそれがベースとなるファイルストアのサポート範囲外にあるときに、最終変更時間の設定を試みた場合のこのメソッドの動作は定義されていません。IOException をスローすることによって、失敗する場合としない場合があります。

使用例: 最終変更時間を現在の時間に設定するとします。

    Path path = ...
    FileTime now = FileTime.fromMillis(System.currentTimeMillis());
    Files.setLastModifiedTime(path, now);
 

パラメータ:

path - ファイルへのパス

time - 新しい最終変更時間

戻り値:

ファイル

例外:

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

SecurityException - デフォルトプロバイダの場合は、セキュリティーマネージャーの checkWrite メソッドが呼び出されてファイルへの書き込みアクセスがチェックされます

関連項目:

BasicFileAttributeView.setTimes(java.nio.file.attribute.FileTime, java.nio.file.attribute.FileTime, java.nio.file.attribute.FileTime)

size

public static long size(Path path)
                 throws IOException

ファイルのサイズをバイトで返します。圧縮、スパースファイルのサポート、またはその他の理由により、サイズがファイルシステム上の実際のサイズと異なる場合があります。通常ファイルでないファイルのサイズは実装固有であるため未指定です。

パラメータ:

path - ファイルへのパス

戻り値:

ファイルサイズ (バイト)

例外:

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

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

関連項目:

BasicFileAttributes.size()

exists

public static boolean exists(Path path,
             LinkOption... options)

ファイルが存在するかどうかをテストします。

options パラメータを使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトではシンボリックリンクはたどられます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

このメソッドの結果がすぐに古くなることに注意してください。このメソッドがファイルの存在を示したとしても、後続のアクセスが成功する保証はありません。このメソッドを、セキュリティー保護を必要とするアプリケーションで使用するときは注意してください。

パラメータ:

path - テストするファイルへのパス

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

戻り値:

ファイルが存在する場合は true。ファイルが存在しないか、その存在を判断できない場合は false。

例外:

SecurityException - デフォルトプロバイダの場合は、SecurityManager.checkRead(String) が呼び出されてファイルへの読み取りアクセスがチェックされます。

関連項目:

notExists(java.nio.file.Path, java.nio.file.LinkOption...)

notExists

public static boolean notExists(Path path,
                LinkOption... options)

このパスが示すファイルが存在しないかどうかをテストします。このメソッドは、ファイルが存在しないことが確認できたときにアクションを取る必要がある場合に使用するものです。

options パラメータを使用すると、ファイルがシンボリックリンクである場合のシンボリックリンクの処理方法を指定できます。デフォルトではシンボリックリンクはたどられます。オプション NOFOLLOW_LINKS が存在する場合は、シンボリックリンクはたどられません。

このメソッドが exists メソッドを補足するものではないことに注意してください。ファイルが存在するかどうか判断できない場合は、どちらのメソッドも false を返します。exists メソッドと同様に、このメソッドの結果もすぐに古くなります。このメソッドがファイルの存在を示したとしても、そのあとのファイルを作成する試みが成功する保証はありません。このメソッドを、セキュリティー保護を必要とするアプリケーションで使用するときは注意してください。

パラメータ:

path - テストするファイルへのパス

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

戻り値:

ファイルが存在しない場合は true。ファイルが存在するか、その存在を判断できない場合は false

例外:

SecurityException - デフォルトプロバイダの場合は、SecurityManager.checkRead(String) が呼び出されてファイルへの読み取りアクセスがチェックされます。

isReadable

public static boolean isReadable(Path path)

ファイルが読み取り可能かどうかをテストします。このメソッドは、ファイルが存在することと、この Java 仮想マシンに、そのファイルを読み取り用に開けるようにする適切な特権があることを確認します。実装によっては、このメソッドが、ファイルへの効果的なアクセスをチェックするために、ファイルアクセス権、アクセス制御リスト、またはその他のファイル属性を読み取る必要がある場合があります。その結果、このメソッドはほかのファイルシステムの操作に関して原始的でない可能性があります。

このメソッドの結果がすぐに古くなることに注意してください。そのあとのファイルを読み取り用に開く試みが成功する (あるいは同じファイルにアクセスすることさえ) 保証はありません。このメソッドを、セキュリティー保護を必要とするアプリケーションで使用するときは注意してください。

パラメータ:

path - チェックするファイルへのパス

戻り値:

ファイルが存在し、読み取り可能な場合は true。ファイルが存在しないか、Java 仮想マシンに十分な特権がないために読み取りアクセスが拒否されるか、またはアクセスを判断できない場合は false

例外:

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

isWritable

public static boolean isWritable(Path path)

ファイルが書き込み可能かどうかをテストします。このメソッドは、ファイルが存在することと、この Java 仮想マシンに、そのファイルを書き込み用に開けるようにする適切な特権があることを確認します。実装によっては、このメソッドが、ファイルへの効果的なアクセスをチェックするために、ファイルアクセス権、アクセス制御リスト、またはその他のファイル属性を読み取る必要がある場合があります。その結果、このメソッドはほかのファイルシステムの操作に関して原始的でない可能性があります。

このメソッドの結果がすぐに古くなることに注意してください。そのあとのファイルを書き込み用に開く試みが成功する (あるいは同じファイルにアクセスすることさえ) 保証はありません。このメソッドを、セキュリティー保護を必要とするアプリケーションで使用するときは注意してください。

パラメータ:

path - チェックするファイルへのパス

戻り値:

ファイルが存在し、書き込み可能な場合は true。ファイルが存在しないか、Java 仮想マシンに十分な特権がないために書き込みアクセスが拒否されるか、またはアクセスを判断できない場合は false

例外:

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

isExecutable

public static boolean isExecutable(Path path)

ファイルが実行可能かどうかをテストします。このメソッドは、ファイルが存在することと、この Java 仮想マシンに、そのファイルを実行するための適切な特権があることを確認します。ディレクトリへのアクセスをチェックする場合はセマンティクスが異なる場合があります。たとえば、UNIX システムでは、実行アクセスのチェックを行うと、Java 仮想マシンに、ファイルまたはサブディレクトリにアクセスするためにディレクトリを検索する権限があることが確認されます。

実装によっては、このメソッドが、ファイルへの効果的なアクセスをチェックするために、ファイルアクセス権、アクセス制御リスト、またはその他のファイル属性を読み取る必要がある場合があります。その結果、このメソッドはほかのファイルシステムの操作に関して原始的でない可能性があります。

このメソッドの結果がすぐに古くなることに注意してください。そのあとのファイルを実行する試みが成功する (あるいは同じファイルにアクセスすることさえ) 保証はありません。このメソッドを、セキュリティー保護を必要とするアプリケーションで使用するときは注意してください。

パラメータ:

path - チェックするファイルへのパス

戻り値:

ファイルが存在し、実行可能な場合は true。ファイルが存在しないか、Java 仮想マシンに十分な特権がないために実行アクセスが拒否されるか、またはアクセスを判断できない場合は false

例外:

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

walkFileTree

public static Path walkFileTree(Path start,
                Set<FileVisitOption> options,
                int maxDepth,
                FileVisitor<? super Path> visitor)
                         throws IOException

ファイルツリーを参照します。

このメソッドは、指定された開始ファイルをルートとしたファイルツリーを参照します。このファイルツリートラバーサルは、ファイルが検出されるごとに呼び出される、指定された FileVisitor を使って深さ優先で行われます。ツリー内のアクセス可能なファイルがすべてビジットされたか、ビジットメソッドから TERMINATE という結果が返されると、ファイルツリートラバーサルは完了します。ビジットメソッドが IOException、キャッチされないエラー、または実行時例外のために終了した場合、そのトラバーサルは停止し、このメソッドの呼び出し元にそのエラーまたは例外が通知されます。

ファイルが検出されるごとに、このメソッドはその BasicFileAttributes の読み取りを試みます。ファイルがディレクトリでない場合は、そのファイル属性で visitFile メソッドが呼び出されます。入出力例外のためにそのファイル属性を読み取れない場合は、その入出力例外で visitFileFailed メソッドが呼び出されます。

ファイルがディレクトリであり、そのディレクトリを開けなかった場合は、入出力例外で visitFileFailed メソッドが呼び出され、その後、デフォルトではそのディレクトリの次の兄弟からファイルツリーの参照が再開されます。

ディレクトリが正常に開いた場合は、ディレクトリ内のエントリとその子孫がビジットされます。すべてのエントリがビジットされたか、ディレクトリの反復処理中に入出力エラーが発生した場合、そのディレクトリはクローズされ、ビジターの postVisitDirectory メソッドが呼び出されます。デフォルトでは、そのディレクトリの次の兄弟からファイルツリーの参照が再開されます。

デフォルトでは、シンボリックリンクはこのメソッドで自動的にたどられません。options パラメータに FOLLOW_LINKS オプションが含まれている場合は、シンボリックリンクがたどられます。リンクをたどっているときに、ターゲットの属性を読み取れない場合、このメソッドはそのリンクの BasicFileAttributes の取得を試みます。それらを読み取れる場合は、そのリンクの属性で visitFile メソッドが呼び出されます (それ以外の場合は、前述のように visitFileFailed メソッドが呼び出されます)。

options パラメータに FOLLOW_LINKS オプションが含まれている場合、このメソッドはサイクルを検出できるようにビジットされたディレクトリを追跡します。サイクルは、ディレクトリの上位ディレクトリの中にエントリが存在する場合に発生します。サイクルの検出を行うには、ディレクトリのファイルキーを記録します。ファイルキーが利用できない場合は、isSameFile メソッドを呼び出して、ディレクトリが上位ディレクトリと同じファイルかどうかを判定します。サイクルが検出されると、それは入出力エラーとして扱われ、FileSystemLoopException のインスタンスで visitFileFailed メソッドが呼び出されます。

maxDepth パラメータは、ビジットするディレクトリレベルの最大数です。値 0 は、セキュリティーマネージャーに拒否されないかぎり、開始ファイルのみがビジットされることを意味します。値 MAX_VALUE を使用すると、すべてのレベルがビジットされるように指定できます。visitFile メソッドは、基本ファイル属性を読み取れない場合を除き、maxDepth で検出されるすべてのファイル (ディレクトリを含む) に対して呼び出されます。基本ファイル属性を読み取れない場合は、visitFileFailed メソッドが呼び出されます。

ビジターから null という結果が返された場合は、NullPointerException がスローされます。

セキュリティーマネージャーがインストールされていて、ファイル (またはディレクトリ) へのアクセスを拒否する場合、それは無視され、ビジターはそのファイル (またはディレクトリ) に対して呼び出されません。

パラメータ:

start - 開始ファイル

options - トラバースを構成するオプション

maxDepth - ビジットするディレクトリレベルの最大数

visitor - 各ファイルに対して呼び出すファイルビジター

戻り値:

開始ファイル

例外:

IllegalArgumentException - maxDepth パラメータが負の値の場合

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

IOException - ビジターメソッドによって入出力エラーがスローされた場合

walkFileTree

public static Path walkFileTree(Path start,
                FileVisitor<? super Path> visitor)
                         throws IOException

ファイルツリーを参照します。

このメソッドの呼び出しは、式を評価することと同様に動作します。

 walkFileTree(start, EnumSet.noneOf(FileVisitOption.class), Integer.MAX_VALUE, visitor)
 

つまり、それはシンボリックリンクをたどらず、ファイルツリーのすべてのレベルをビジットします。

パラメータ:

start - 開始ファイル

visitor - 各ファイルに対して呼び出すファイルビジター

戻り値:

開始ファイル

例外:

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

IOException - ビジターメソッドによって入出力エラーがスローされた場合

newBufferedReader

public static BufferedReader newBufferedReader(Path path,
                               Charset cs)
                                        throws IOException

ファイルを読み取り用に開き、そのファイルから効果的な方法でテキストを読み取るために使用できる BufferedReader を返します。ファイルから取得したバイトは、指定された文字セットを使用して文字にデコードされます。読み取りはファイルの最初から始まります。

ファイルから読み取る Reader メソッドは、形式が間違っているか、またはマップできないバイトシーケンスが読み取られた場合に IOException をスローします。

パラメータ:

path - ファイルへのパス

cs - デコードに使用する文字セット

戻り値:

ファイルからテキストを読み取るための、デフォルトのバッファーサイズを持つ、バッファーに入れられた新しいリーダー

例外:

IOException - ファイルのオープン中に入出力エラーが発生した場合

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

関連項目:

readAllLines(java.nio.file.Path, java.nio.charset.Charset)

newBufferedWriter

public static BufferedWriter newBufferedWriter(Path path,
                               Charset cs,
                               OpenOption... options)
                                        throws IOException

ファイルを書き込み用に開くか作成して、そのファイルに効果的な方法でテキストを書き込むために使用できる BufferedWriter を返します。options パラメータはファイルを作成または開く方法を指定します。オプションがない場合、このメソッドは CREATE、TRUNCATE_EXISTING、および WRITE オプションがあるかのように機能します。つまり、書き込み用にファイルを開きます (存在しない場合は作成し、存在する場合は最初に既存の通常ファイルをサイズ 0 に切り詰めます)。

テキストを書き込む Writer メソッドは、指定された文字セットを使ってテキストをエンコードできない場合に IOException をスローします。

パラメータ:

path - ファイルへのパス

cs - エンコードに使用する文字セット

options - ファイルを開く方法を指定するオプション

戻り値:

ファイルにテキストを書き込むための、デフォルトのバッファーサイズを持つ、バッファーに入れられた新しいライター

例外:

IOException - ファイルのオープンまたは作成中に入出力エラーが発生した場合

UnsupportedOperationException - 未サポートのオプションが指定された場合

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

関連項目:

write(Path,Iterable,Charset,OpenOption[])

copy

public static long copy(InputStream in,
        Path target,
        CopyOption... options)
                 throws IOException

すべてのバイトを入力ストリームからファイルにコピーします。復帰すると、その入力ストリームはストリームの終わりに配置されます。

デフォルトでは、ターゲットファイルがすでに存在するか、シンボリックリンクである場合、コピーは失敗します。REPLACE_EXISTING オプションが指定されていて、ターゲットファイルがすでに存在する場合は、それが空でないディレクトリでなければ置換されます。ターゲットファイルが存在し、それがシンボリックリンクである場合は、そのシンボリックリンクが置換されます。このリリースでは、REPLACE_EXISTING オプションは、このメソッドでサポートされる必要のある唯一のオプションです。将来のリリースでは、追加のオプションがサポートされる可能性があります。

入力ストリームからの読み取り中またはファイルへの書き込み中に入出力エラーが発生する場合は、ターゲットファイルが作成されたあとや、数バイトが読み取られたり、書き込まれたりしたあとでそうなることがあります。その結果、入力ストリームがストリームの終わりに配置されず、整合性のない状態になる可能性があります。入出力エラーが発生した場合は入力ストリームをただちにクローズすることを強くお勧めします。

このメソッドは、入力ストリームからの読み取り (またはファイルへの書き込み) を無期限にブロックすることがあります。コピー中に入力ストリームが非同期クローズされたり、スレッドの割り込みが発生したりした場合の動作は、入力ストリームやファイルシステムプロバイダによって大きく異なるため、特定できません。

使用例:Web ページを取得し、それをファイルを保存するとします。

     Path path = ...
     URI u = URI.create("http://java.sun.com/");
     try (InputStream in = u.toURL().openStream()) {
         Files.copy(in, path);
     }
 

パラメータ:

in - 読み取り元の入力ストリーム

target - ファイルへのパス

options - コピーをどのように実行するべきかを指定するオプション

戻り値:

読み取られるまたは書き込まれるバイト数

例外:

IOException - 読み取りまたは書き込み中に入出力エラーが発生した場合。

FileAlreadyExistsException - ターゲットファイルは存在するけれども、REPLACE_EXISTING オプションが指定されていないために置換できない場合 (オプションの固有例外)

DirectoryNotEmptyException - REPLACE_EXISTING オプションが指定されているけれども、空でないディレクトリであるために置換できない場合 (オプションの固有例外) *

UnsupportedOperationException - サポートされていないコピーオプションが options に含まれる場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkWrite メソッドが呼び出されてファイルへの書き込みアクセスがチェックされます。REPLACE_EXISTING オプションが指定されている場合は、セキュリティーマネージャーの checkDelete メソッドが呼び出されて、既存のファイルを削除できるかどうかがチェックされます。

copy

public static long copy(Path source,
        OutputStream out)
                 throws IOException

すべてのバイトをファイルから出力ストリームにコピーします。

ファイルからの読み取り中または出力ストリームへの書き込み中に入出力エラーが発生する場合は、数バイトが読み取られたり、書き込まれたりしたあとでそうなることがあります。その結果、出力ストリームが整合性のない状態になる可能性があります。入出力エラーが発生した場合は出力ストリームをただちにクローズすることを強くお勧めします。

このメソッドは、出力ストリームへの書き込み (またはファイルからの読み取り) を無期限にブロックすることがあります。コピー中に出力ストリームが非同期クローズされたり、スレッドの割り込みが発生したりした場合の動作は、入力ストリームやファイルシステムプロバイダによって大きく異なるため、特定できません。

指定された出力ストリームが Flushable である場合は、バッファーに入っている出力をフラッシュするために、このメソッドの完了後に、その flush メソッドを呼び出すことが必要になることがあります。

パラメータ:

source - ファイルへのパス

out - 書き込み先の出力ストリーム

戻り値:

読み取られるまたは書き込まれるバイト数

例外:

IOException - 読み取りまたは書き込み中に入出力エラーが発生した場合。

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

readAllBytes

public static byte[] readAllBytes(Path path)
                           throws IOException

ファイルからすべてのバイトを読み取ります。このメソッドは、すべてのバイトが読み取られたか、入出力エラーまたは他の実行時例外がスローされたときに必ずそのファイルがクローズされるようにします。

このメソッドが、すべてのバイトを 1 つのバイト配列に読み取ると都合が良い簡単なケースで使用するものであることに注意してください。大きなファイルを読み取ることを目的とはしていません。

パラメータ:

path - ファイルへのパス

戻り値:

ファイルから読み取られたバイトを含むバイト配列

例外:

IOException - ストリームからの読み取り中に入出力エラーが発生した場合

OutOfMemoryError - 必要なサイズの配列を割り当てられない場合 (ファイルが 2GB を超えるなど)

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

readAllLines

public static List<String> readAllLines(Path path,
                        Charset cs)
                                 throws IOException

ファイルからすべての行を読み取ります。このメソッドは、すべてのバイトが読み取られたか、入出力エラーまたは他の実行時例外がスローされたときに必ずそのファイルがクローズされるようにします。ファイルから取得したバイトは、指定された文字セットを使用して文字にデコードされます。

このメソッドは、次を行末記号と認識します。

• \u000D と \u000A、キャリッジリターンと改行
• \u000A、改行
• \u000D、キャリッジリターン

将来のリリースでは、追加の Unicode 行末記号が認識される可能性があります。

このメソッドが、すべての行を 1 回の操作で読み取ると都合が良い簡単なケースで使用するものであることに注意してください。大きなファイルを読み取ることを目的とはしていません。

パラメータ:

path - ファイルへのパス

cs - デコードに使用する文字セット

戻り値:

ファイルから 1 つの List として読み取られた行。その List が変更可能であるかどうかは実装に依存しているため、特定できない

例外:

IOException - ファイルからの読み取り中に入出力エラーが発生した場合、または形式が間違っているか、マップできないバイトシーケンスが読み取られた場合

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

関連項目:

newBufferedReader(java.nio.file.Path, java.nio.charset.Charset)

write

public static Path write(Path path,
         byte[] bytes,
         OpenOption... options)
                  throws IOException

バイトをファイルに書き込みます。options パラメータはファイルを作成または開く方法を指定します。オプションがない場合、このメソッドは CREATE、TRUNCATE_EXISTING、および WRITE オプションがあるかのように機能します。つまり、書き込み用にファイルを開きます (存在しない場合は作成し、そうでない場合は最初に既存の通常ファイルをサイズ 0 に切り詰めます)。バイト配列内のすべてのバイトがファイルに書き込まれます。このメソッドは、すべてのバイトが書き込まれた (あるいは、入出力エラーまたは他の実行時例外がスローされた) ときに必ずそのファイルがクローズされるようにします。入出力エラーが発生した場合は、ファイルの作成または切り詰めが行われたあと、またはファイルに数バイト書き込まれたあとに行われる場合があります。

使用例:デフォルトでは、このメソッドは新しいファイルを作成するか、既存のファイルに上書きします。その代わりに、バイトを既存のファイルに追加するとします。

     Path path = ...
     byte[] bytes = ...
     Files.write(path, bytes, StandardOpenOption.APPEND);
 

パラメータ:

path - ファイルへのパス

bytes - 書き込むバイトを含むバイト配列

options - ファイルを開く方法を指定するオプション

戻り値:

パス

例外:

IOException - ファイルへの書き込み中またはファイルの作成中に入出力エラーが発生した場合

UnsupportedOperationException - 未サポートのオプションが指定された場合

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

write

public static Path write(Path path,
         Iterable<? extends CharSequence> lines,
         Charset cs,
         OpenOption... options)
                  throws IOException

テキスト行をファイルに書き込みます。各行は文字シーケンスであり、システムプロパティー line.separator で定義されているように、各行の終端がプラットフォームの行区切り文字で表されるファイルに順々に書き込まれます。文字は、指定された文字セットを使ってバイトにエンコードされます。

options パラメータはファイルを作成または開く方法を指定します。オプションがない場合、このメソッドは CREATE、TRUNCATE_EXISTING、および WRITE オプションがあるかのように機能します。つまり、書き込み用にファイルを開きます (存在しない場合は作成し、そうでない場合は最初に既存の通常ファイルをサイズ 0 に切り詰めます)。このメソッドは、すべての行が書き込まれた (あるいは、入出力エラーまたは他の実行時例外がスローされた) ときに必ずそのファイルがクローズされるようにします。入出力エラーが発生した場合は、ファイルの作成または切り詰めが行われたあと、またはファイルに数バイト書き込まれたあとに行われる場合があります。

パラメータ:

path - ファイルへのパス

lines - 文字シーケンスすべてについて反復処理を行うオブジェクト

cs - エンコードに使用する文字セット

options - ファイルを開く方法を指定するオプション

戻り値:

パス

例外:

IOException - ファイルへの書き込み中またはファイルの作成中に入出力エラーが発生したか、指定された文字セットを使ってテキストをエンコードできない場合

UnsupportedOperationException - 未サポートのオプションが指定された場合

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