java.nio.file

クラス FileStore

java.lang.Object

java.nio.file.FileStore

public abstract class FileStore
extends Object

ファイル用のストレージです。FileStore は、ストレージプール、デバイス、パーティション、具象ファイルシステム、またはその他の実装固有のファイルストレージの手段を表します。ファイルが格納される FileStore を取得するには、getFileStore メソッドを呼び出し、すべてのファイルストアを列挙するには、getFileStores メソッドを呼び出します。

ファイルストアでは、このクラスで定義されているメソッドのほかに、一連のファイルストア属性の読み取り専用または更新可能なビューを提供する 1 つ以上の FileStoreAttributeView クラスもサポートしていることがあります。

導入されたバージョン:

1.7

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

コンストラクタ

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

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract Object	getAttribute(String attribute) ファイルストア属性の値を読み取ります。
abstract <V extends FileStoreAttributeView> V	getFileStoreAttributeView(Class<V> type) 指定されたタイプの FileStoreAttributeView を返します。
abstract long	getTotalSpace() ファイルストアのサイズをバイトで返します。
abstract long	getUnallocatedSpace() ファイルストア内の未割り当てのバイト数を返します。
abstract long	getUsableSpace() このファイルストア上で、この Java 仮想マシンが利用できるバイト数を返します。
abstract boolean	isReadOnly() このファイルストアが読み取り専用であるかどうかを判定します。
abstract String	name() このファイルストアの名前を返します。
abstract boolean	supportsFileAttributeView(Class<? extends FileAttributeView> type) このファイルストアが、指定されたファイル属性ビューで識別されるファイル属性をサポートするかどうかを示します。
abstract boolean	supportsFileAttributeView(String name) このファイルストアが、指定されたファイル属性ビューで識別されるファイル属性をサポートするかどうかを示します。
abstract String	type() このファイルストアの種類を返します。

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

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

コンストラクタの詳細

FileStore

protected FileStore()

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

メソッドの詳細

name

public abstract String name()

このファイルストアの名前を返します。その名前の形式は実装に大きく依存します。通常はストレージプールまたはボリュームの名前になります。

このメソッドで返される文字列は、toString メソッドで返される文字列とは異なる場合があります。

戻り値:

このファイルストアの名前

type

public abstract String type()

このファイルストアの種類を返します。このメソッドで返される文字列の形式は、実装に大きく依存します。たとえば、使用される形式を示したり、ファイルストアがローカルかリモートかを示したりする場合があります。

戻り値:

このファイルストアの種類を表す文字列

isReadOnly

public abstract boolean isReadOnly()

このファイルストアが読み取り専用であるかどうかを判定します。ファイルストアが読み取り専用となるのは、それが書き込み操作またはその他のファイルへの変更をサポートしていない場合です。ファイルを作成する、既存のファイルを書き込み用に開くなどを試みると、IOException がスローされます。

戻り値:

このファイルストアが読み取り専用である場合にかぎり true

getTotalSpace

public abstract long getTotalSpace()
                            throws IOException

ファイルストアのサイズをバイトで返します。

戻り値:

ファイルストアのサイズ (バイト単位)

例外:

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

getUsableSpace

public abstract long getUsableSpace()
                             throws IOException

このファイルストア上で、この Java 仮想マシンが利用できるバイト数を返します。

返される利用可能なバイト数は、確かなものではなく単なる手掛かりであり、これらのバイトのほとんどまたは一部を使用できます。利用可能なバイト数は、領域属性が取得された直後は正確である可能性がもっとも高くなります。外部の入出力操作 (この Java 仮想マシンの外部のシステムで行われる入出力操作を含む) によって不正確になります。

戻り値:

利用可能なバイト数

例外:

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

getUnallocatedSpace

public abstract long getUnallocatedSpace()
                                  throws IOException

ファイルストア内の未割り当てのバイト数を返します。

返される未割り当てのバイト数は、1 つの手掛かりであり、保証を示すものではありません。これらのバイトのほとんどまたは一部を使用できる可能性を示しています。未割り当てのバイト数は、領域属性が取得された直後は正確である可能性がもっとも高くなります。外部の入出力操作 (この仮想マシンの外部のシステムで行われる入出力操作を含む) によって不正確になります。

戻り値:

未割り当てのバイト数

例外:

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

supportsFileAttributeView

public abstract boolean supportsFileAttributeView(Class<? extends FileAttributeView> type)

このファイルストアが、指定されたファイル属性ビューで識別されるファイル属性をサポートするかどうかを示します。

このメソッドを呼び出して、そのファイルストアが BasicFileAttributeView をサポートするかどうかを判定すると、常に true が返されます。デフォルトプロバイダの場合は、ファイルストアがローカルストレージでないと、このメソッドが正しい結果を返すことは保証できません。この理由は実装固有であるため未指定です。

パラメータ:

type - ファイル属性ビューのタイプ

戻り値:

ファイル属性ビューがサポートされる場合にのみ true

supportsFileAttributeView

public abstract boolean supportsFileAttributeView(String name)

このファイルストアが、指定されたファイル属性ビューで識別されるファイル属性をサポートするかどうかを示します。

このメソッドを呼び出して、そのファイルストアが BasicFileAttributeView (「basic」という名前で識別される) をサポートするかどうかを判定すると、常に true が返されます。デフォルトプロバイダの場合は、ファイルストアがローカルストレージでないと、このメソッドが正しい結果を返すことは保証できません。この理由は実装固有であるため未指定です。

パラメータ:

name - ファイル属性ビューの name

戻り値:

ファイル属性ビューがサポートされる場合にのみ true

getFileStoreAttributeView

public abstract <V extends FileStoreAttributeView> V getFileStoreAttributeView(Class<V> type)

指定されたタイプの FileStoreAttributeView を返します。

このメソッドは、ファイルストア属性の読み取りや更新を行うための型保証されたメソッドをファイルストア属性ビューで定義する場合に使用するよう意図されています。type パラメータは必要な属性ビューのタイプで、メソッドはサポートされている場合はそのタイプのインスタンスを返します。

パラメータ:

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

戻り値:

指定されたタイプのファイルストア属性ビュー。その属性ビューが利用できない場合は null

getAttribute

public abstract Object getAttribute(String attribute)
                             throws IOException

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

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

view-name:attribute-name

ここでの文字 ':' はそれ自体を表します。

view-name は、一連のファイル属性を識別する AttributeView の name です。attribute-name はその属性の名前です。

使用例: ZFS 圧縮が有効であるかどうかを確認するとします (「zfs」ビューがサポートされていると仮定)。

    boolean compression = (Boolean)fs.getAttribute("zfs:compression");
 

パラメータ:

attribute - 読み取る属性

戻り値:

属性値。一部の属性では null が有効な場合もある

例外:

UnsupportedOperationException - その属性ビューが使用できないか、それが属性の読み取りをサポートしていない場合

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