java.nio.file.spi

クラス FileSystemProvider

java.lang.Object

java.nio.file.spi.FileSystemProvider

public abstract class FileSystemProvider
extends Object

ファイルシステムのサービスプロバイダクラスです。Files クラスによって定義されているメソッドは通常、このクラスのインスタンスに処理を委譲します。

ファイルシステムプロバイダは、このクラスで定義されている abstract メソッドを実装する、このクラスの具象実装です。プロバイダは、URI スキームによって識別されます。デフォルトプロバイダは、「file」という URI スキームによって識別されます。それは、Java 仮想マシンからアクセス可能なファイルシステムへのアクセスを提供する FileSystem を作成します。FileSystems クラスは、ファイルシステムプロバイダを検出してロードする方法を定義します。デフォルトプロバイダは通常、システムデフォルトのプロバイダですが、システムプロパティー java.nio.file.spi.DefaultFileSystemProvider が設定されている場合はオーバーライドできます。その場合、このプロバイダには引数を 1 つ取るコンストラクタがあり、その仮パラメータ型は FileSystemProvider です。ほかのすべてのプロバイダには、そのプロバイダを初期化する、引数を取らないコンストラクタが備わっています。

プロバイダとは、1 つまたは複数の FileSystem インスタンスのファクトリです。各ファイルシステムは、URI のスキームがプロバイダのスキームと一致する場合に、その URI によって識別されます。たとえば、デフォルトプロバイダは "file:///" という URI によって識別されます。たとえば、メモリーベースのファイルシステムは、"memory:///?name=logfs" などの URI によって識別されることがあります。newFileSystem メソッドはファイルシステムの作成に使用でき、getFileSystem メソッドはプロバイダによって作成された既存のファイルシステムへの参照を取得する場合に使用できます。プロバイダが単一ファイルシステムのファクトリである場合は、そのファイルシステムがプロバイダの初期化時に作成されるか、それともあとで newFileSystem メソッドの呼び出し時に作成されるかはプロバイダによって異なります。デフォルトプロバイダの場合は、プロバイダの初期化時に FileSystem が作成されます。

このクラス内のすべてのメソッドは、複数の並行スレッドで安全に使用できます。

導入されたバージョン:

1.7

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	FileSystemProvider() このクラスの新しいインスタンスを初期化します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract void	checkAccess(Path path, AccessMode... modes) ファイルの存在および、オプションでアクセシビリティーをチェックします。
abstract void	copy(Path source, Path target, CopyOption... options) ファイルをターゲットファイルにコピーします。
abstract void	createDirectory(Path dir, FileAttribute<?>... attrs) 新しいディレクトリを作成します。
void	createLink(Path link, Path existing) 既存のファイルに対して新しいリンク (ディレクトリエントリ) を作成します。
void	createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs) ターゲットへのシンボリックリンクを作成します。
abstract void	delete(Path path) ファイルを削除します。
boolean	deleteIfExists(Path path) ファイルが存在する場合は削除します。
abstract <V extends FileAttributeView> V	getFileAttributeView(Path path, Class<V> type, LinkOption... options) 指定されたタイプのファイル属性ビューを返します。
abstract FileStore	getFileStore(Path path) ファイルが置かれているファイルストアを表す FileStore を返します。
abstract FileSystem	getFileSystem(URI uri) このプロバイダによって作成された既存の FileSystem を返します。
abstract Path	getPath(URI uri) 指定された URI を変換することによって、Path オブジェクトを返します。
abstract String	getScheme() このプロバイダを識別する URI スキームを返します。
static List<FileSystemProvider>	installedProviders() インストールされているファイルシステムプロバイダのリストを返します。
abstract boolean	isHidden(Path path) ファイルが隠しファイルとみなされるかどうかを判断します。
abstract boolean	isSameFile(Path path, Path path2) 2 つのパスが同じファイルを検出するかどうかを判断します。
abstract void	move(Path source, Path target, CopyOption... options) ファイルをターゲットファイルに移動するか、そのファイル名を変更します。
AsynchronousFileChannel	newAsynchronousFileChannel(Path path, Set<? extends OpenOption> options, ExecutorService executor, FileAttribute<?>... attrs) 読み込みまたは書き込み (あるいはその両方) 用のファイルを開くか作成し、そのファイルにアクセスするための非同期のファイルチャネルを返します。
abstract SeekableByteChannel	newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) ファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。
abstract DirectoryStream<Path>	newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) ディレクトリを開き、そのディレクトリ内のエントリに対して反復処理を行う DirectoryStream を返します。
FileChannel	newFileChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) 読み取りまたは書き込み (あるいはその両方) 用のファイルを開くか作成し、そのファイルにアクセスするためのファイルチャネルを返します。
FileSystem	newFileSystem(Path path, Map<String,?> env) ファイルの内容にファイルシステムとしてアクセスする新しい FileSystem を構築します。
abstract FileSystem	newFileSystem(URI uri, Map<String,?> env) URI で識別される新しい FileSystem オブジェクトを構築します。
InputStream	newInputStream(Path path, OpenOption... options) ファイルを開き、そのファイルから読み取る入力ストリームを返します。
OutputStream	newOutputStream(Path path, OpenOption... options) ファイルを開くか作成して、そのファイルにバイトを書き込むために使用できる出力ストリームを返します。
abstract <A extends BasicFileAttributes> A	readAttributes(Path path, Class<A> type, LinkOption... options) 一括操作としてファイル属性を読み取ります。
abstract Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options) 一括操作として一連のファイル属性を読み取ります。
Path	readSymbolicLink(Path link) シンボリックリンクのターゲットを読み取ります。
abstract void	setAttribute(Path path, String attribute, Object value, LinkOption... options) ファイル属性の値を設定します。

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

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

コンストラクタの詳細

FileSystemProvider

protected FileSystemProvider()

このクラスの新しいインスタンスを初期化します。

構築中、プロバイダはデフォルトプロバイダに関連付けられたファイルに安全にアクセスできますが、インストールされたほかのプロバイダの循環ロードを避けるために注意が必要です。インストールされたプロバイダの循環ロードが検出された場合は、未指定のエラーがスローされます。

例外:

SecurityException - セキュリティーマネージャーがインストールされており、それが RuntimePermission("fileSystemProvider") を拒否した場合

メソッドの詳細

installedProviders

public static List<FileSystemProvider> installedProviders()

インストールされているファイルシステムプロバイダのリストを返します。

FileSystems クラスで説明されているように、このメソッドの最初の呼び出しによって、デフォルトプロバイダが初期化され (まだ初期化されていない場合)、インストールされているほかのすべてのプロバイダがロードされます。

戻り値:

インストールされているファイルシステムプロバイダの変更不可能なリスト。このリストには少なくとも 1 つの要素 (つまり、デフォルトのファイルシステムプロバイダ) が含まれています

例外:

ServiceConfigurationError - サービスプロバイダのロード中にエラーが発生した場合

getScheme

public abstract String getScheme()

このプロバイダを識別する URI スキームを返します。

戻り値:

URI スキーム

newFileSystem

public abstract FileSystem newFileSystem(URI uri,
                       Map<String,?> env)
                                  throws IOException

URI で識別される新しい FileSystem オブジェクトを構築します。このメソッドは、URI で識別される新しいファイルシステムを開くために FileSystems.newFileSystem(URI,Map) メソッドによって呼び出されます。

uri パラメータは、このプロバイダがサポートしているスキームと同じスキーム (大文字小文字の区別なし) を持つ、階層型の絶対 URI です。URI の正確な形式はプロバイダに大きく依存します。env パラメータは、ファイルシステムを構成するためのプロバイダ固有のプロパティーのマップです。

このメソッドは、ファイルシステムが以前にこのメソッドの呼び出しによって作成されたためにすでに存在している場合には FileSystemAlreadyExistsException をスローします。ファイルシステムが閉じられると、以前に作成したファイルシステムと同じ URI で新しいファイルシステムを作成することをプロバイダが許可するかどうかはプロバイダによって異なります。

パラメータ:

uri - URI 参照

env - ファイルシステムを構成するためのプロバイダ固有のプロパティーのマップ。空でも可

戻り値:

新しいファイルシステム

例外:

IllegalArgumentException - uri パラメータの事前条件が満たされない場合、または env パラメータにプロバイダが必要とするプロパティーが含まれていない場合、またはプロパティー値が無効な場合

IOException - そのファイルシステムの作成中に入出力エラーが発生した場合

SecurityException - セキュリティーマネージャーがインストールされ、それがファイルシステムプロバイダ実装によって必要とされる未指定のアクセス権を拒否する場合

FileSystemAlreadyExistsException - そのファイルシステムがすでに作成されている場合

getFileSystem

public abstract FileSystem getFileSystem(URI uri)

このプロバイダによって作成された既存の FileSystem を返します。

このメソッドは、newFileSystem(URI,Map) メソッドを呼び出して作成された FileSystem への参照を返します。newFileSystem(Path,Map) メソッドを作成したファイルシステムは、このメソッドでは返されません。ファイルシステムはその URI で識別されます。その正確な形式はプロバイダに大きく依存します。デフォルトプロバイダの場合、URI のパスコンポーネントは "/" であり、機関、クエリー、およびフラグメントの各コンポーネントは未定義です (未定義のコンポーネントは null で表される)。

このプロバイダによって作成されたファイルシステムが閉じると、このメソッドが、閉じられたファイルシステムへの参照を返すか FileSystemNotFoundException をスローするかは、プロバイダによって異なります。以前に作成したファイルシステムと同じ URI で新しいファイルシステムを作成することをプロバイダが許可する場合は、ファイルシステムが閉じられたあとで (かつnewFileSystem メソッドによって新しいインスタンスが作成される前に) このメソッドを呼び出すと、例外がスローされます。

セキュリティーマネージャーがインストールされている場合は、プロバイダ実装は既存のファイルシステムへの参照を返す前にアクセス権をチェックすることを必要とする場合があります。デフォルトファイルシステムの場合は、アクセス権のチェックは不要です。

パラメータ:

uri - URI 参照

戻り値:

ファイルシステム

例外:

IllegalArgumentException - uri パラメータの事前条件が満たされない場合

FileSystemNotFoundException - ファイルシステムが存在しない場合

SecurityException - セキュリティーマネージャーがインストールされ、それが未指定のアクセス権を拒否する場合。

getPath

public abstract Path getPath(URI uri)

指定された URI を変換することによって、Path オブジェクトを返します。結果となる Path は、すでに存在しているか自動的に構築される FileSystem に関連付けられます。

URI の正確な形式はファイルシステムプロバイダに依存します。デフォルトプロバイダの場合、URI スキームは "file" であり、指定された URI には空でないパスコンポーネントと、未定義のクエリーおよびフラグメントコンポーネントが含まれます。結果となる Path はデフォルトの default FileSystem に関連付けられます。

セキュリティーマネージャーがインストールされている場合、プロバイダ実装でアクセス権のチェックが必要になることがあります。デフォルトファイルシステムの場合は、アクセス権のチェックは不要です。

パラメータ:

uri - 変換対象の URI

例外:

IllegalArgumentException - URI スキームがこのプロバイダを識別しないか、uri パラメータのほかの事前条件が満たされていない場合

FileSystemNotFoundException - URI によって識別されるファイルシステムが存在せず、自動的に作成することもできない場合

SecurityException - セキュリティーマネージャーがインストールされ、それが未指定のアクセス権を拒否する場合。

newFileSystem

public FileSystem newFileSystem(Path path,
                       Map<String,?> env)
                         throws IOException

ファイルの内容にファイルシステムとしてアクセスする新しい FileSystem を構築します。

このメソッドは、1 つまたは複数のファイルの内容がファイルシステムとして扱われる擬似ファイルシステムの特殊なプロバイダ用です。env パラメータは、ファイルシステムを構成するためのプロバイダ固有のプロパティーのマップです。

このプロバイダがそのようなファイルシステムの作成をサポートしていない場合、またはそのプロバイダが指定されたファイルのファイルタイプを認識しない場合は、UnsupportedOperationException がスローされます。このメソッドのデフォルト実装は UnsupportedOperationException をスローします。

パラメータ:

path - ファイルへのパス

env - ファイルシステムを構成するためのプロバイダ固有のプロパティーのマップ。空でも可

戻り値:

新しいファイルシステム

例外:

UnsupportedOperationException - このプロバイダがそれらの内容にファイルシステムとしてアクセスすることをサポートしていないか、指定されたファイルのファイルタイプを認識しない場合

IllegalArgumentException - プロバイダが必要とするプロパティーが env パラメータに含まれていないか、プロパティー値が無効な場合

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

SecurityException - セキュリティーマネージャーがインストールされ、それが未指定のアクセス権を拒否する場合。

newInputStream

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

ファイルを開き、そのファイルから読み取る入力ストリームを返します。このメソッドは、Files.newInputStream(java.nio.file.Path, java.nio.file.OpenOption...) メソッドで指定されたとおりに機能します。

このメソッドのデフォルト実装では、newByteChannel(java.nio.file.Path, java.util.Set<? extends java.nio.file.OpenOption>, java.nio.file.attribute.FileAttribute<?>...) メソッドを呼び出したかのようにファイルへのチャネルを開き、そのチャネルからバイトを読み取るストリームを構築します。このメソッドは必要に応じてオーバーライドすることをお勧めします。

パラメータ:

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

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

戻り値:

新しい入力ストリーム

例外:

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

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

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

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

newOutputStream

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

ファイルを開くか作成して、そのファイルにバイトを書き込むために使用できる出力ストリームを返します。このメソッドは、Files.newOutputStream(java.nio.file.Path, java.nio.file.OpenOption...) メソッドで指定されたとおりに機能します。

このメソッドのデフォルト実装では、newByteChannel(java.nio.file.Path, java.util.Set<? extends java.nio.file.OpenOption>, java.nio.file.attribute.FileAttribute<?>...) メソッドを呼び出したかのようにファイルへのチャネルを開き、そのチャネルにバイトを書き込むストリームを構築します。このメソッドは必要に応じてオーバーライドすることをお勧めします。

パラメータ:

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

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

戻り値:

新しい出力ストリーム

例外:

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

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

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

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

newFileChannel

public FileChannel newFileChannel(Path path,
                         Set<? extends OpenOption> options,
                         FileAttribute<?>... attrs)
                           throws IOException

読み取りまたは書き込み (あるいはその両方) 用のファイルを開くか作成し、そのファイルにアクセスするためのファイルチャネルを返します。このメソッドは、FileChannel.open メソッドで指定されたとおりに機能します。プロバイダがファイルチャネルの構築に必要なすべての機能をサポートしているわけではない場合は、UnsupportedOperationException がスローされます。デフォルトプロバイダは、ファイルチャネルの作成をサポートしている必要があります。デフォルト実装では、オーバーライドされない場合、UnsupportedOperationException がスローされます。

パラメータ:

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

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

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

戻り値:

新しいファイルチャネル

例外:

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

UnsupportedOperationException - このプロバイダがファイルチャネルの作成をサポートしていない場合、あるいは未サポートのオープンオプションまたはファイル属性が指定された場合

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

SecurityException - デフォルトプロバイダで、ファイルが読み取り用に開かれた場合は、SecurityManager.checkRead(String) メソッドが呼び出されてファイルへの読み取りアクセスがチェックされます。ファイルが書き込み用に開かれた場合は、SecurityManager.checkWrite(String) メソッドが呼び出されて書き込みアクセスがチェックされます。

newAsynchronousFileChannel

public AsynchronousFileChannel newAsynchronousFileChannel(Path path,
                                                 Set<? extends OpenOption> options,
                                                 ExecutorService executor,
                                                 FileAttribute<?>... attrs)
                                                   throws IOException

読み込みまたは書き込み (あるいはその両方) 用のファイルを開くか作成し、そのファイルにアクセスするための非同期のファイルチャネルを返します。このメソッドは、AsynchronousFileChannel.open メソッドで指定されたとおりに機能します。プロバイダが非同期ファイルチャネルの構築に必要なすべての機能をサポートしているわけではない場合は、UnsupportedOperationException がスローされます。デフォルトプロバイダは、非同期ファイルチャネルの作成をサポートしている必要があります。このメソッドのデフォルト実装では、オーバーライドされない場合、UnsupportedOperationException がスローされます。

パラメータ:

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

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

executor - スレッドプール、またはチャネルをデフォルトのスレッドプールに関連付ける場合は null

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

戻り値:

新しい非同期ファイルチャネル

例外:

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

UnsupportedOperationException - このプロバイダが非同期ファイルチャネルの作成をサポートしていない場合、あるいは未サポートのオープンオプションまたはファイル属性が指定された場合

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

SecurityException - デフォルトプロバイダで、ファイルが読み取り用に開かれた場合は、SecurityManager.checkRead(String) メソッドが呼び出されてファイルへの読み取りアクセスがチェックされます。ファイルが書き込み用に開かれた場合は、SecurityManager.checkWrite(String) メソッドが呼び出されて書き込みアクセスがチェックされます。

newByteChannel

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

ファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。このメソッドは、Files.newByteChannel(Path,Set,FileAttribute[]) メソッドで指定されたとおりに機能します。

パラメータ:

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

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

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

戻り値:

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

例外:

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

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

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

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

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

newDirectoryStream

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

ディレクトリを開き、そのディレクトリ内のエントリに対して反復処理を行う DirectoryStream を返します。このメソッドは、Files.newDirectoryStream(java.nio.file.Path, java.nio.file.DirectoryStream.Filter) メソッドで指定されたとおりに機能します。

パラメータ:

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

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

戻り値:

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

例外:

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

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

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

createDirectory

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

新しいディレクトリを作成します。このメソッドは、Files.createDirectory(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...) メソッドで指定されたとおりに機能します。

パラメータ:

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

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

例外:

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

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

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

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

createSymbolicLink

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

ターゲットへのシンボリックリンクを作成します。このメソッドは、Files.createSymbolicLink(java.nio.file.Path, java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...) メソッドで指定されたとおりに機能します。

このメソッドのデフォルト実装は UnsupportedOperationException をスローします。

パラメータ:

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

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

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

例外:

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

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

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

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

createLink

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

既存のファイルに対して新しいリンク (ディレクトリエントリ) を作成します。このメソッドは、Files.createLink(java.nio.file.Path, java.nio.file.Path) メソッドで指定されたとおりに機能します。

このメソッドのデフォルト実装は UnsupportedOperationException をスローします。

パラメータ:

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

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

例外:

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

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

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

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

delete

public abstract void delete(Path path)
                     throws IOException

ファイルを削除します。このメソッドは、Files.delete(java.nio.file.Path) メソッドで指定されたとおりに機能します。

パラメータ:

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

例外:

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

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

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

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

deleteIfExists

public boolean deleteIfExists(Path path)
                       throws IOException

ファイルが存在する場合は削除します。このメソッドは、Files.deleteIfExists(java.nio.file.Path) メソッドで指定されたとおりに機能します。

このメソッドのデフォルト実装では、単に delete(java.nio.file.Path) を呼び出し、ファイルが存在しない場合は NoSuchFileException を無視します。必要に応じてオーバーライドされることもあります。

パラメータ:

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

戻り値:

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

例外:

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

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

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

readSymbolicLink

public Path readSymbolicLink(Path link)
                      throws IOException

シンボリックリンクのターゲットを読み取ります。このメソッドは、Files.readSymbolicLink(java.nio.file.Path) メソッドで指定されたとおりに機能します。

このメソッドのデフォルト実装は UnsupportedOperationException をスローします。

パラメータ:

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

例外:

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

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

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

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

copy

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

ファイルをターゲットファイルにコピーします。このメソッドは、ソースとターゲットのパスがどちらもこのプロバイダに関連付けられていなければならない点を除き、Files.copy(Path,Path,CopyOption[]) メソッドによって指定されたとおりに機能します。

パラメータ:

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

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

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

例外:

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

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

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

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

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

move

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

ファイルをターゲットファイルに移動するか、そのファイル名を変更します。このメソッドは、ソースとターゲットのパスがどちらもこのプロバイダに関連付けられていなければならない点を除き、Files.move(java.nio.file.Path, java.nio.file.Path, java.nio.file.CopyOption...) メソッドによって指定されたとおりに機能します。

パラメータ:

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

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

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

例外:

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

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

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

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

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

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

isSameFile

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

2 つのパスが同じファイルを検出するかどうかを判断します。このメソッドは、Files.isSameFile(java.nio.file.Path, java.nio.file.Path) メソッドで指定されたとおりに機能します。

パラメータ:

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

path2 - もう一方のパス

戻り値:

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

例外:

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

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

isHidden

public abstract boolean isHidden(Path path)
                          throws IOException

ファイルが隠しファイルとみなされるかどうかを判断します。このメソッドは、Files.isHidden(java.nio.file.Path) メソッドで指定されたとおりに機能します。

このメソッドは isHidden メソッドから呼び出されます。

パラメータ:

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

戻り値:

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

例外:

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

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

getFileStore

public abstract FileStore getFileStore(Path path)
                                throws IOException

ファイルが置かれているファイルストアを表す FileStore を返します。このメソッドは、Files.getFileStore(java.nio.file.Path) メソッドで指定されたとおりに機能します。

パラメータ:

path - ファイルへのパス

戻り値:

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

例外:

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

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

checkAccess

public abstract void checkAccess(Path path,
               AccessMode... modes)
                          throws IOException

ファイルの存在および、オプションでアクセシビリティーをチェックします。

このメソッドは、ファイルのアクセシビリティーをチェックするために isReadable、isWritable、および isExecutable メソッドによって使用されることがあります。

このメソッドは、次のように、modes パラメータに指定されたすべてのアクセスモードに従って、ファイルの存在と、Java 仮想マシンにそのファイルへのアクセスを許可する適切な特権があることを確認します。

値	説明
READ	ファイルが存在することと、Java 仮想マシンにそのファイルを読み取るためのアクセス権があることを確認します。
WRITE	ファイルが存在することと、Java 仮想マシンにそのファイルに書き込むためのアクセス権があることを確認します。
EXECUTE	ファイルが存在することと、Java 仮想マシンにそのファイルを実行するためのアクセス権があることを確認します。ディレクトリへのアクセスをチェックする場合はセマンティクスが異なる場合があります。たとえば、UNIX システムでは、EXECUTE アクセスのチェックを行うと、Java 仮想マシンに、ファイルまたはサブディレクトリにアクセスするためにディレクトリを検索する権限があることが確認されます。

modes パラメータの長さがゼロの場合は、そのファイルの存在が確認されます。

このオブジェクトによって参照されるファイルがシンボリックリンクである場合、このメソッドはシンボリックリンクをたどります。実装によっては、このメソッドが、ファイルへの効果的なアクセスをチェックするために、ファイルアクセス権、アクセス制御リスト、またはその他のファイル属性を読み取る必要がある場合があります。ファイルへの効果的なアクセスを調べるために、いくつかの属性へのアクセスが必要になる場合があるため、一部の実装では、このメソッドはほかのファイルシステム操作に関して原子的でない可能性があります。

パラメータ:

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

modes - チェックするアクセスモード。要素がない場合もある

例外:

UnsupportedOperationException - 実装では READ、WRITE、および EXECUTE アクセスのチェックをサポートしている必要があります。この例外は、Access 列挙が将来のリリースで拡張されることを考慮して指定されています。

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

AccessDeniedException - 要求されたアクセスが拒否される場合、または Java 仮想マシンに十分な特権がないなどの理由でアクセスを調べられない場合。(オプションの固有例外)

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

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

getFileAttributeView

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

指定されたタイプのファイル属性ビューを返します。このメソッドは、Files.getFileAttributeView(java.nio.file.Path, java.lang.Class<V>, java.nio.file.LinkOption...) メソッドで指定されたとおりに機能します。

パラメータ:

path - ファイルへのパス

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

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

戻り値:

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

readAttributes

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

一括操作としてファイル属性を読み取ります。このメソッドは、Files.readAttributes(Path,Class,LinkOption[]) メソッドで指定されたとおりに機能します。

パラメータ:

path - ファイルへのパス

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

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

戻り値:

ファイル属性

例外:

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

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

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

readAttributes

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

一括操作として一連のファイル属性を読み取ります。このメソッドは、Files.readAttributes(Path,String,LinkOption[]) メソッドで指定されたとおりに機能します。

パラメータ:

path - ファイルへのパス

attributes - 読み取る属性

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

戻り値:

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

例外:

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

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

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

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

setAttribute

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

ファイル属性の値を設定します。このメソッドは、Files.setAttribute(java.nio.file.Path, java.lang.String, java.lang.Object, java.nio.file.LinkOption...) メソッドで指定されたとおりに機能します。

パラメータ:

path - ファイルへのパス

attribute - 設定する属性

value - 属性値

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

例外:

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

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

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

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

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