Класс FileStore

java.lang.Object

java.nio.file.FileStore

public abstract class FileStore extends Object

Хранилище для файлов. Объект getFileStore представляет собой хранилище, устройство, раздел, том, конкретную файловую систему или другой способ хранения файлов, специфичный для реализации. Место хранения файла определяется вызовом метода getFileStore, или все хранилища файлов могут быть перечислены путём вызова метода getFileStores.

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

Since:: 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()`	Возвращает тип этого хранилища файлов.

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

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

Возвращает:: количество нераспределённых байтов
Выбрасывает:: 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 определяет атрибут для чтения и имеет вид:

view-name:attribute-name

где символ ':' представляет собой сам себя.

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

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

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

Параметры:: attribute - атрибут для чтения
Возвращает:: значение атрибута; null может быть допустимым для некоторых атрибутов
Выбрасывает:: UnsupportedOperationException - если представление атрибутов недоступно или не поддерживает чтение атрибута; IOException - если произошла ошибка ввода-вывода

© 1993, 2023, 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/21/docs/api/java.base/java/nio/file/FileStore.html