Spec-Zone.ru › OpenJDK 17

Интерфейс UserDefinedFileAttributeView

Все суперинтерфейсы:
AttributeView, FileAttributeView
public interface UserDefinedFileAttributeView extends FileAttributeView
Представление атрибутов файла, предоставляющее просмотр пользовательских атрибутов файла, иногда называемых расширенными атрибутами. Пользовательские атрибуты файла используются для хранения метаданных файла, не имеющих смысла для файловой системы. Оно предназначено в первую очередь для реализаций файловых систем, которые напрямую поддерживают такую возможность, но могут быть эмулированы. Подробности такой эмуляции сильно зависят от реализации и поэтому не специфицируются.

Это FileAttributeView предоставляет представление пользовательских атрибутов файла как набора пар имя/значение, где имя атрибута представлено String. Реализация может потребовать кодирования и декодирования из представления платформы или файловой системы при доступе к атрибуту. Значение имеет непрозрачное содержимое. Это представление атрибутов определяет методы read и write для чтения значения в или записи из ByteBuffer. Это FileAttributeView не предназначено для использования в случаях, когда размер значения атрибута больше, чем Integer.MAX_VALUE.

Пользовательские атрибуты могут использоваться в некоторых реализациях для хранения атрибутов безопасности, поэтому, по крайней мере, в случае стандартного поставщика, все методы, которые обращаются к пользовательским атрибутам, требуют разрешения RuntimePermission("accessUserDefinedAttributes") при установке менеджера безопасности.

Метод supportsFileAttributeView может использоваться для проверки, поддерживает ли конкретная FileStore хранение пользовательских атрибутов.

В случаях, когда требуется динамический доступ к атрибутам файла, можно использовать метод getAttribute для чтения значения атрибута. Значение атрибута возвращается в виде массива байтов (byte[]). Метод setAttribute может быть использован для записи значения пользовательского атрибута из буфера (как если бы вызывался метод write) или массива байтов (byte[]).

С момента:
1.7

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

Модификатор и тип Метод Описание
void delete(String name)
Удаляет пользовательский атрибут.
List<String> list()
Возвращает список, содержащий имена пользовательских атрибутов.
String name()
Возвращает имя этого представления атрибутов.
int read(String name, ByteBuffer dst)
Считывает значение пользовательского атрибута в буфер.
int size(String name)
Возвращает размер значения пользовательского атрибута.
int write(String name, ByteBuffer src)
Записывает значение пользовательского атрибута из буфера.

Подробное описание методов

name

String name()
Возвращает имя этого представления атрибутов. Представления атрибутов этого типа имеют имя "user".
Определено в:
name в интерфейсе AttributeView
Возвращает:
имя представления атрибутов

list

List<String> list() throws IOException
Возвращает список, содержащий имена пользовательских атрибутов.
Возвращает:
Неизменяемый список, содержащий имена пользовательских атрибутов файла
Исключения:
IOException - Если произошла ошибка ввода-вывода
SecurityException - В случае стандартного поставщика, если установлен менеджер безопасности и он отказывается предоставить RuntimePermission("accessUserDefinedAttributes") или его метод checkRead отказывается предоставить доступ для чтения к файлу.

size

int size(String name) throws IOException
Возвращает размер значения пользовательского атрибута.
Параметры:
name - Имя атрибута
Возвращает:
Размер значения атрибута в байтах.
Исключения:
ArithmeticException - Если размер атрибута больше, чем Integer.MAX_VALUE
IOException - Если произошла ошибка ввода-вывода
SecurityException - В случае стандартного поставщика, если установлен менеджер безопасности и он отказывается предоставить RuntimePermission("accessUserDefinedAttributes") или его метод checkRead отказывается предоставить доступ для чтения к файлу.

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 - Если произошла ошибка ввода-вывода или в буфере назначения недостаточно места для значения атрибута
SecurityException - В случае стандартного поставщика, если установлен менеджер безопасности и он отказывается предоставить RuntimePermission("accessUserDefinedAttributes") или его метод checkRead отказывается предоставить доступ для чтения к файлу.
См. также:
  • size(java.lang.String)

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 - Если произошла ошибка ввода-вывода
SecurityException - В случае стандартного поставщика, если установлен менеджер безопасности и он отказывается предоставить RuntimePermission("accessUserDefinedAttributes") или его метод checkWrite отказывается предоставить доступ для записи к файлу.

delete

void delete(String name) throws IOException
Удаляет пользовательский атрибут.
Параметры:
name - Имя атрибута
Исключения:
IOException - Если произошла ошибка ввода-вывода или атрибута не существует
SecurityException - В случае стандартного поставщика, если установлен менеджер безопасности и он отказывается предоставить RuntimePermission("accessUserDefinedAttributes") или его метод checkWrite отказывается предоставить доступ для записи к файлу.

© 1993, 2021, 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/17/docs/api/java.base/java/nio/file/attribute/UserDefinedFileAttributeView.html

Spec-Zone.ru

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