Интерфейс UserDefinedFileAttributeView
- Все суперинтерфейсы:
AttributeView, FileAttributeView
public interface UserDefinedFileAttributeView extends FileAttributeView
Это FileAttributeView предоставляет доступ к пользовательским атрибутам файла в виде набора пар «имя/значение», где имя атрибута представлено объектом String. При доступе к атрибуту реализации может потребоваться кодировать и декодировать его значение в соответствии с представлением платформы или файловой системы. Содержимое значения непрозрачно. Это представление атрибутов определяет методы read и write для чтения значения в ByteBuffer или записи значения из него. Это FileAttributeView не предназначено для использования, если размер значения атрибута превышает Integer.MAX_VALUE.
Метод supportsFileAttributeView можно использовать, чтобы проверить, поддерживает ли конкретное FileStore хранение пользовательских атрибутов.
Если требуется динамический доступ к атрибутам файла, для чтения значения атрибута можно использовать метод getAttribute. Значение атрибута возвращается в виде массива байтов (byte[]). Метод setAttribute можно использовать для записи значения пользовательского атрибута из буфера (как если бы был вызван метод write) или массива байтов (byte[]).
- Начиная с версии:
- 1.7
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
delete |
Удаляет пользовательский атрибут. |
List |
list() |
Возвращает список имен пользовательских атрибутов. |
String |
name() |
Возвращает имя этого представления атрибутов. |
int |
read |
Считывает значение пользовательского атрибута в буфер. |
int |
size |
Возвращает размер значения пользовательского атрибута. |
int |
write |
Записывает значение пользовательского атрибута из буфера. |
Подробное описание методов
name
String name()
"user".- Определено в:
-
nameв интерфейсеAttributeView - Возвращает:
- имя представления атрибутов
list
List<String> list() throws IOException
- Возвращает:
- Немодифицируемый список имен пользовательских атрибутов файла
- Выбрасывает:
-
IOException— если произошла ошибка ввода-вывода
size
int size(String name) throws IOException
- Параметры:
-
name— имя атрибута - Возвращает:
- Размер значения атрибута в байтах.
- Выбрасывает:
-
ArithmeticException— если размер атрибута превышаетInteger.MAX_VALUE -
IOException— если произошла ошибка ввода-вывода
read
int read(String name, ByteBuffer dst) throws IOException
Этот метод считывает значение атрибута в заданный буфер как последовательность байтов и завершается ошибкой, если оставшегося в буфере места недостаточно для чтения значения атрибута целиком. Количество байтов, записанных в буфер, равно n, где n — размер значения атрибута. Первый байт последовательности находится по индексу p, а последний — по индексу p + n - 1, где p — текущая позиция буфера. После возврата позиция буфера будет равна p + n; его предел не изменится.
Пример использования: Предположим, мы хотим считать тип MIME файла, сохраненный в виде пользовательского атрибута с именем "user.mimetype".
UserDefinedFileAttributeView view =
Files.getFileAttributeView(path, UserDefinedFileAttributeView.class);
String name = "user.mimetype";
ByteBuffer buf = ByteBuffer.allocate(view.size(name));
view.read(name, buf);
buf.flip();
String value = Charset.defaultCharset().decode(buf).toString();
- Параметры:
-
name— имя атрибута -
dst— буфер назначения - Возвращает:
- Количество прочитанных байтов, возможно, ноль
- Выбрасывает:
-
IllegalArgumentException— если буфер назначения доступен только для чтения -
IOException— если произошла ошибка ввода-вывода или в буфере назначения недостаточно места для значения атрибута - См. также:
write
int write(String name, ByteBuffer src) throws IOException
Этот метод записывает значение атрибута из заданного буфера как последовательность байтов. Размер передаваемого значения равен r, где r — количество оставшихся в буфере байтов, то есть src.remaining(). Последовательность байтов передается из буфера начиная с индекса p, где p — текущая позиция буфера. После возврата позиция буфера будет равна
p + n, где n — количество переданных байтов; его предел не изменится.
Если атрибут с заданным именем уже существует, его значение заменяется. Если атрибут не существует, он создается. Зависит от реализации, являются ли проверка существования атрибута и его создание атомарными по отношению к другим операциям файловой системы.
Если для хранения атрибута недостаточно места или имя либо значение атрибута превышает максимальный размер, определяемый реализацией, выбрасывается исключение IOException.
Пример использования: Предположим, мы хотим записать тип MIME файла в виде пользовательского атрибута:
UserDefinedFileAttributeView view =
Files.getFileAttributeView(path, UserDefinedFileAttributeView.class);
view.write("user.mimetype", Charset.defaultCharset().encode("text/html"));
- Параметры:
-
name— имя атрибута -
src— буфер, содержащий значение атрибута - Возвращает:
- Количество записанных байтов, возможно, ноль
- Выбрасывает:
-
IOException— если произошла ошибка ввода-вывода
delete
void delete(String name) throws IOException
- Параметры:
-
name— имя атрибута - Выбрасывает:
-
IOException— если произошла ошибка ввода-вывода или атрибут не существует
© 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/attribute/UserDefinedFileAttributeView.html