java.nio.file.attribute

Интерфейсный UserDefinedFileAttributeView

Все Суперинтерфейсы:

AttributeView, FileAttributeView

public interface UserDefinedFileAttributeView
extends FileAttributeView

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

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

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

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

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

С тех пор:

1.7

Сводка метода

Методы

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

Деталь метода

имя

String name()

Возвращает имя этого представления атрибута. У представлений атрибута этого типа есть имя "user".

Определенный:

name в интерфейсе AttributeView

список

List<String> list()
                  throws IOException

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

Возвраты:

Неподдающийся изменению список continaing имена определяемого пользователем файла

Броски:

IOException - Если ошибка ввода-вывода происходит

SecurityException - В случае провайдера по умолчанию устанавливается менеджер безопасности, и это отрицает RuntimePermission("accessUserDefinedAttributes") или checkRead метод отрицает доступ для чтения к файлу.

размер

int size(String name)
         throws IOException

Возвращает размер значения определяемого пользователем атрибута.

Параметры:

name - Название атрибута

Возвраты:

Размер значения атрибута, в байтах.

Броски:

ArithmeticException - Если размер атрибута больше чем Integer.MAX_VALUE

IOException - Если ошибка ввода-вывода происходит

SecurityException - В случае провайдера по умолчанию устанавливается менеджер безопасности, и это отрицает RuntimePermission("accessUserDefinedAttributes") или checkRead метод отрицает доступ для чтения к файлу.

читать

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)

записать

int write(String name,
        ByteBuffer src)
          throws IOException

Пишет значение определяемого пользователем атрибута от буфера.

Этот метод пишет значение атрибута от данного буфера как последовательность байтов. Размер значения, чтобы передать r, где r число байтов, остающихся в буфере, который является src.remaining(). Последовательность байтов передается от буферного запуска по индексу p, где p позиция буфера. По возврату позиция буфера будет равна p + n, где n число переданных байтов; его предел не будет изменяться.

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

Где есть недостаточное пространство, чтобы сохранить атрибут, или название атрибута или значение превышают реализацию определенный максимальный размер тогда 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 метод отрицает доступ для записи к файлу.

удалить

void delete(String name)
            throws IOException

Удаляет определяемый пользователем атрибут.

Параметры:

name - Название атрибута

Броски:

IOException - Если ошибка ввода-вывода происходит, или атрибут не существует

SecurityException - В случае провайдера по умолчанию устанавливается менеджер безопасности, и это отрицает RuntimePermission("accessUserDefinedAttributes") или checkWrite метод отрицает доступ для записи к файлу.