Spec-Zone.ru › OpenJDK 25

Класс FileStore

java.lang.Object
java.nio.file.FileStore
public abstract class FileStore extends Object
Хранилище файлов. FileStore представляет собой пул хранения, устройство, раздел, том, конкретную файловую систему или другое зависящее от реализации средство хранения файлов. FileStore для места хранения файла получают вызовом метода getFileStore, а все файловые хранилища можно перечислить, вызвав метод getFileStores.

Помимо методов, определённых этим классом, файловое хранилище может поддерживать один или несколько классов FileStoreAttributeView, предоставляющих доступ только для чтения или обновляемое представление набора атрибутов файлового хранилища.

Начиная с:
1.7

Краткое описание конструкторов

FileStore()
Модификатор Конструктор Описание
protected
Инициализирует новый экземпляр этого класса.

Краткое описание методов

Модификатор и тип Метод Описание
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()
Возвращает тип этого файлового хранилища.

Методы, объявленные в классе 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.

Возвращаемое количество нераспределённых байтов является подсказкой, но не гарантией того, что можно использовать большую часть или все эти байты. Количество нераспределённых байтов, скорее всего, будет точным сразу после возврата этого метода. Любые внешние операции ввода-вывода, в том числе выполняемые в системе за пределами этой виртуальной машины, могут привести к неточности значения.

Возвращает:
текущее количество нераспределённых байтов
Выбрасывает:
IOException — если произошла ошибка ввода-вывода

getBlockSize

public long getBlockSize() throws IOException
Возвращает количество байтов в блоке этого файлового хранилища.

Данные файлов обычно организованы в последовательности байтов фиксированного размера, называемые блоками. Блок — это наименьшая единица хранения файлового хранилища. Каждая операция чтения и записи выполняется с использованием целого числа блоков.

Требования к реализации:
Реализация в этом классе выбрасывает 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 задаёт атрибут для чтения и имеет вид:

имя-представления:имя-атрибута
где символ ':' обозначает сам себя.

имя-представления — это name класса AttributeView, определяющего набор атрибутов файлов. имя-атрибута — имя атрибута.

Пример использования: допустим, мы хотим узнать, включено ли сжатие ZFS (при условии, что поддерживается представление "zfs"):

    boolean compression = (Boolean)fs.getAttribute("zfs:compression");
Параметры:
attribute — атрибут для чтения
Возвращает:
значение атрибута; для некоторых атрибутов допустимо значение null
Выбрасывает:
UnsupportedOperationException — если представление атрибутов недоступно или не поддерживает чтение атрибута
IOException — если произошла ошибка ввода-вывода

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/nio/file/FileStore.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API