Класс AsynchronousFileChannel

protected AsynchronousFileChannel()

public static AsynchronousFileChannel open(Path file, Set<? extends OpenOption> options, ExecutorService executor, FileAttribute<?>... attrs) throws IOException

Параметры:

file — путь к файлу, который нужно открыть или создать

options — параметры, определяющие способ открытия файла

executor — пул потоков или null для привязки канала к пулу потоков по умолчанию

attrs — необязательный список файловых атрибутов, которые атомарно устанавливаются при создании файла

Возвращает:

новый асинхронный файловый канал

Исключения:

IllegalArgumentException — если набор содержит недопустимую комбинацию параметров

UnsupportedOperationException — если file связан с провайдером, не поддерживающим создание асинхронных файловых каналов, указан неподдерживаемый параметр открытия или массив содержит атрибут, который нельзя атомарно установить при создании файла

FileAlreadyExistsException — если файл с таким именем уже существует, указан параметр CREATE_NEW и файл открывается для записи (необязательное специфическое исключение)

IOException — если возникает другая ошибка ввода-вывода

public static AsynchronousFileChannel open(Path file, OpenOption... options) throws IOException

    ch.open(file, opts, null, new FileAttribute<?>[0]);

Параметры:

file — путь к файлу, который нужно открыть или создать

options — параметры, определяющие способ открытия файла

Возвращает:

новый асинхронный файловый канал

Исключения:

IllegalArgumentException — если набор содержит недопустимую комбинацию параметров

UnsupportedOperationException — если file связан с провайдером, не поддерживающим создание файловых каналов, или указан неподдерживаемый параметр открытия

FileAlreadyExistsException — если файл с таким именем уже существует, указан параметр CREATE_NEW и файл открывается для записи (необязательное специфическое исключение)

IOException — если возникает ошибка ввода-вывода

public abstract long size() throws IOException

Возвращает:

текущий размер файла этого канала в байтах

Исключения:

ClosedChannelException — если этот канал закрыт

IOException — если возникает другая ошибка ввода-вывода

public abstract AsynchronousFileChannel truncate(long size) throws IOException

Параметры:

size — новый размер, неотрицательное количество байтов

Возвращает:

этот файловый канал

Исключения:

NonWritableChannelException — если этот канал не был открыт для записи

ClosedChannelException — если этот канал закрыт

IllegalArgumentException — если новый размер отрицателен

IOException — если возникает другая ошибка ввода-вывода

public abstract void force(boolean metaData) throws IOException

Параметры:

metaData — если true, этот метод должен принудительно записать на устройство хранения изменения и содержимого файла, и его метаданных; в противном случае достаточно принудительно записать только изменения содержимого

Исключения:

ClosedChannelException — если этот канал закрыт

IOException — если возникает другая ошибка ввода-вывода

public abstract <A> void lock(long position, long size, boolean shared, A attachment, CompletionHandler<FileLock, ? super A> handler)

Параметры типа:

A — тип присоединяемого объекта

Параметры:

position — позиция начала блокируемой области; должна быть неотрицательной

size — размер блокируемой области; должен быть неотрицательным, а сумма position + size должна быть неотрицательной. Значение ноль означает блокировку всех байтов от указанной начальной позиции до конца файла независимо от того, будет ли файл впоследствии увеличен или усечен

shared — true для запроса совместной блокировки; в этом случае канал должен быть открыт для чтения (и, возможно, для записи); false для запроса исключительной блокировки; в этом случае канал должен быть открыт для записи (и, возможно, для чтения)

attachment — объект, присоединяемый к операции ввода-вывода; может быть null

handler — обработчик результата

Исключения:

OverlappingFileLockException — если виртуальная машина Java уже удерживает блокировку, перекрывающую запрошенную область, или уже выполняется попытка заблокировать перекрывающуюся область

IllegalArgumentException — если не соблюдены предварительные условия для параметров

NonReadableChannelException — если shared равно true, но канал не был открыт для чтения

NonWritableChannelException — если shared равно false, но канал не был открыт для записи

public final <A> void lock(A attachment, CompletionHandler<FileLock, ? super A> handler)

    ch.lock(0L, Long.MAX_VALUE, false, att, handler)

Параметры типа:

A — тип присоединяемого объекта

Параметры:

attachment — объект, присоединяемый к операции ввода-вывода; может быть null

handler — обработчик результата

Исключения:

OverlappingFileLockException — если виртуальная машина Java уже удерживает блокировку или уже выполняется попытка заблокировать область

NonWritableChannelException — если канал не был открыт для записи

public abstract Future<FileLock> lock(long position, long size, boolean shared)

Параметры:

position — позиция начала блокируемой области; должна быть неотрицательной

size — размер блокируемой области; должен быть неотрицательным, а сумма position + size должна быть неотрицательной. Значение ноль означает блокировку всех байтов от указанной начальной позиции до конца файла независимо от того, будет ли файл впоследствии увеличен или усечен

shared — true для запроса совместной блокировки; в этом случае канал должен быть открыт для чтения (и, возможно, для записи); false для запроса исключительной блокировки; в этом случае канал должен быть открыт для записи (и, возможно, для чтения)

Возвращает:

объект Future, представляющий ожидающий результат

Исключения:

OverlappingFileLockException — если виртуальная машина Java уже удерживает блокировку или уже выполняется попытка заблокировать область

IllegalArgumentException — если не соблюдены предварительные условия для параметров

NonReadableChannelException — если shared равно true, но канал не был открыт для чтения

NonWritableChannelException — если shared равно false, но канал не был открыт для записи

public final Future<FileLock> lock()

    ch.lock(0L, Long.MAX_VALUE, false)

Возвращает:

объект Future, представляющий ожидающий результат

Исключения:

OverlappingFileLockException — если виртуальная машина Java уже удерживает блокировку или уже выполняется попытка заблокировать область

NonWritableChannelException — если канал не был открыт для записи

public abstract FileLock tryLock(long position, long size, boolean shared) throws IOException

Параметры:

position — позиция начала блокируемой области; должна быть неотрицательной

size — размер блокируемой области; должен быть неотрицательным, а сумма position + size должна быть неотрицательной. Значение ноль означает блокировку всех байтов от указанной начальной позиции до конца файла независимо от того, будет ли файл впоследствии увеличен или усечен

shared — true для запроса совместной блокировки, false для запроса исключительной блокировки

Возвращает:

объект блокировки, представляющий только что полученную блокировку, или null, если получить блокировку не удалось, поскольку другая программа удерживает блокировку перекрывающейся области

Исключения:

IllegalArgumentException — если не соблюдены предварительные условия для параметров

ClosedChannelException — если этот канал закрыт

OverlappingFileLockException — если виртуальная машина Java уже удерживает блокировку, перекрывающую запрошенную область, или другой поток уже заблокирован в этом методе и пытается заблокировать перекрывающуюся область того же файла

NonReadableChannelException — если shared равно true, но канал не был открыт для чтения

NonWritableChannelException — если shared равно false, но канал не был открыт для записи

IOException — если возникает другая ошибка ввода-вывода

См. также:

• lock(Object,CompletionHandler)
• lock(long,long,boolean,Object,CompletionHandler)
• tryLock()

public final FileLock tryLock() throws IOException

    ch.tryLock(0L, Long.MAX_VALUE, false)

Возвращает:

объект блокировки, представляющий только что полученную блокировку, или null, если получить блокировку не удалось, поскольку другая программа удерживает блокировку перекрывающейся области

Исключения:

ClosedChannelException — если этот канал закрыт

OverlappingFileLockException — если виртуальная машина Java уже удерживает блокировку, перекрывающую запрошенную область, или другой поток уже заблокирован в этом методе и пытается заблокировать перекрывающуюся область

NonWritableChannelException — если shared равно false, но канал не был открыт для записи

IOException — если возникает другая ошибка ввода-вывода

См. также:

• lock(Object,CompletionHandler)
• lock(long,long,boolean,Object,CompletionHandler)
• tryLock(long,long,boolean)

public abstract <A> void read(ByteBuffer dst, long position, A attachment, CompletionHandler<Integer, ? super A> handler)

Параметры типа:

A — тип присоединяемого объекта

Параметры:

dst — буфер, в который будут переданы байты

position — позиция файла, с которой начинается передача; должна быть неотрицательной

attachment — объект, присоединяемый к операции ввода-вывода; может быть null

handler — обработчик результата

Исключения:

IllegalArgumentException — если позиция отрицательна, буфер доступен только для чтения или является представлением MemorySegment, выделенного в арене с привязкой к потоку

NonReadableChannelException — если этот канал не был открыт для чтения

public abstract Future<Integer> read(ByteBuffer dst, long position)

Параметры:

dst — буфер, в который будут переданы байты

position — позиция файла, с которой начинается передача; должна быть неотрицательной

Возвращает:

объект Future, представляющий ожидающий результат

Исключения:

IllegalArgumentException — если позиция отрицательна, буфер доступен только для чтения или является представлением MemorySegment, выделенного в арене с привязкой к потоку

NonReadableChannelException — если этот канал не был открыт для чтения

public abstract <A> void write(ByteBuffer src, long position, A attachment, CompletionHandler<Integer, ? super A> handler)

Параметры типа:

A — тип присоединяемого объекта

Параметры:

src — буфер, из которого будут переданы байты

position — позиция файла, с которой начинается передача; должна быть неотрицательной

attachment — объект, присоединяемый к операции ввода-вывода; может быть null

handler — обработчик результата

Исключения:

IllegalArgumentException — если позиция отрицательна или буфер является представлением MemorySegment, выделенного в арене с привязкой к потоку

NonWritableChannelException — если этот канал не был открыт для записи

public abstract Future<Integer> write(ByteBuffer src, long position)

Параметры:

src — Буфер, из которого будут передаваться байты

position — Позиция в файле, с которой начинается передача; должна быть неотрицательной

Возвращает:

Объект Future, представляющий ожидающий результат

Исключения:

IllegalArgumentException — Если позиция отрицательна или буфер является представлением MemorySegment, выделенного в арене с привязкой к потоку

NonWritableChannelException — Если этот канал не был открыт для записи