Интерфейс UserDefinedFileAttributeView

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

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

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

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

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

Методы

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

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

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 отклоняет доступ для записи к файлу.