モジュール java.base
パッケージ 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)
    ファイル・ストア属性の値を読み取ります。
    long
    getBlockSize()
    このファイル・ストア内のブロックあたりのバイト数を返します。
    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
      ファイル・ストアのサイズをバイトで返します。 ファイル・ストア内のバイトの合計数がLong.MAX_VALUEより大きい場合は、Long.MAX_VALUEが返されます。
      戻り値:
      ファイル・ストアのサイズ(バイト単位)
      例外:
      IOException - 入出力エラーが発生した場合

    • getUsableSpace

      public abstract long getUsableSpace() throws IOException
      このファイル・ストア上で、このJava仮想マシンが利用できるバイト数を返します。 使用可能なバイト数がLong.MAX_VALUEより大きい場合、Long.MAX_VALUEが返されます。

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

      戻り値:
      利用可能なバイト数
      例外:
      IOException - 入出力エラーが発生した場合

    • getUnallocatedSpace

      public abstract long getUnallocatedSpace() throws IOException
      ファイル・ストア内の未割当てのバイト数を返します。 未割当てのバイト数がLong.MAX_VALUEより大きい場合、Long.MAX_VALUEが返されます。

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

      戻り値:
      未割当てのバイト数
      例外:
      IOException - 入出力エラーが発生した場合

    • getBlockSize

      public long getBlockSize() throws IOException
      このファイル・ストア内のブロックあたりのバイト数を返します。

      ファイル・ストレージは、通常、blocksと呼ばれる個別のバイト列に編成されます。 ブロックはファイル・ストアの最小単位です。 すべての読み取りおよび書き込み操作は、複数のブロックで実行されます。

      実装要件:
      このクラスの実装はUnsupportedOperationExceptionをスローします。
      戻り値:
      このファイル・ストアのブロック・サイズを表す正の値(バイト単位)
      例外:
      IOException - 入出力エラーが発生した場合
      UnsupportedOperationException - 操作がサポートされていない場合
      導入されたバージョン:
      10

    • 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パラメータは必要な属性ビューのタイプで、メソッドはサポートされている場合はそのタイプのインスタンスを返します。

      型パラメータ:
      V - FileStoreAttributeViewタイプ
      パラメータ:
      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 - 入出力エラーが発生した場合