Класс FileChannel

protected FileChannel()

public static FileChannel open(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) throws IOException

Параметры:

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

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

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

Возвращает:

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

Исключения:

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

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

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

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

Начиная с версии:

1.7

public static FileChannel open(Path path, OpenOption... options) throws IOException

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

Параметры:

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

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

Возвращает:

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

Исключения:

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

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

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

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

Начиная с версии:

1.7

public abstract int read(ByteBuffer dst) throws IOException

Определено в:

read в интерфейсе ReadableByteChannel

Определено в:

read в интерфейсе SeekableByteChannel

Параметры:

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

Возвращает:

число прочитанных байтов, возможно, ноль, или -1, если канал достиг конца потока

Исключения:

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции чтения

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции чтения, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

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

public abstract long read(ByteBuffer[] dsts, int offset, int length) throws IOException

Определено в:

read в интерфейсе ScatteringByteChannel

Параметры:

dsts — буферы, в которые передаются байты

offset — смещение в массиве буферов, указывающее на первый буфер, в который передаются байты; должно быть неотрицательным и не превышать dsts.length

length — максимальное число буферов для доступа; должно быть неотрицательным и не превышать dsts.length - offset

Возвращает:

число прочитанных байтов, возможно, ноль, или -1, если канал достиг конца потока

Исключения:

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции чтения

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции чтения, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

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

public final long read(ByteBuffer[] dsts) throws IOException

Определено в:

read в интерфейсе ScatteringByteChannel

Параметры:

dsts — буферы, в которые передаются байты

Возвращает:

число прочитанных байтов, возможно, ноль, или -1, если канал достиг конца потока

Исключения:

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции чтения

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции чтения, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

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

public abstract int write(ByteBuffer src) throws IOException

Определено в:

write в интерфейсе SeekableByteChannel

Определено в:

write в интерфейсе WritableByteChannel

Параметры:

src — буфер, из которого извлекаются байты

Возвращает:

число записанных байтов, возможно, ноль

Исключения:

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции записи

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции записи, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

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

public abstract long write(ByteBuffer[] srcs, int offset, int length) throws IOException

Определено в:

write в интерфейсе GatheringByteChannel

Параметры:

srcs — буферы, из которых извлекаются байты

offset — смещение в массиве буферов, указывающее на первый буфер, из которого извлекаются байты; должно быть неотрицательным и не превышать srcs.length

length — максимальное число буферов для доступа; должно быть неотрицательным и не превышать srcs.length - offset

Возвращает:

число записанных байтов, возможно, ноль

Исключения:

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции записи

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции записи, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

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

public final long write(ByteBuffer[] srcs) throws IOException

Определено в:

write в интерфейсе GatheringByteChannel

Параметры:

srcs — буферы, из которых извлекаются байты

Возвращает:

число записанных байтов, возможно, ноль

Исключения:

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции записи

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции записи, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

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

public abstract long position() throws IOException

Определено в:

position в интерфейсе SeekableByteChannel

Возвращает:

позицию файла в этом канале — неотрицательное целое число, обозначающее количество байтов от начала файла до текущей позиции

Исключения:

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

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

public abstract FileChannel position(long newPosition) throws IOException

Определено в:

position в интерфейсе SeekableByteChannel

Параметры:

newPosition — новая позиция, неотрицательное целое число, обозначающее количество байтов от начала файла

Возвращает:

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

Исключения:

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

IllegalArgumentException — если новая позиция отрицательна

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

public abstract long size() throws IOException

Определено в:

size в интерфейсе SeekableByteChannel

Возвращает:

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

Исключения:

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

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

public abstract FileChannel truncate(long size) throws IOException

Определено в:

truncate в интерфейсе SeekableByteChannel

Параметры:

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

Возвращает:

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

Исключения:

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

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

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

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

public abstract void force(boolean metaData) throws IOException

Параметры:

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

Исключения:

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

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

public abstract long transferTo(long position, long count, WritableByteChannel target) throws IOException

Параметры:

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

count — максимальное число передаваемых байтов; должно быть неотрицательным

target — целевой канал

Возвращает:

фактически переданное число байтов, возможно, ноль

Исключения:

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

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

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

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

AsynchronousCloseException — если другой поток закрывает один из каналов во время передачи

ClosedByInterruptException — если другой поток прерывает текущий поток во время передачи, тем самым закрывая оба канала и устанавливая статус прерывания текущего потока

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

public abstract long transferFrom(ReadableByteChannel src, long position, long count) throws IOException

Параметры:

src — исходный канал

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

count — максимальное число передаваемых байтов; должно быть неотрицательным

Возвращает:

фактически переданное число байтов, возможно, ноль

Исключения:

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

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

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

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

AsynchronousCloseException — если другой поток закрывает один из каналов во время передачи

ClosedByInterruptException — если другой поток прерывает текущий поток во время передачи, тем самым закрывая оба канала и устанавливая статус прерывания текущего потока

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

public abstract int read(ByteBuffer dst, long position) throws IOException

Параметры:

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

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

Возвращает:

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

Выбрасывает:

IllegalArgumentException — если позиция отрицательна или буфер доступен только для чтения

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

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции чтения

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции чтения, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

public abstract int write(ByteBuffer src, long position) throws IOException

Параметры:

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

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

Возвращает:

Количество записанных байтов, возможно, ноль

Выбрасывает:

IllegalArgumentException — если позиция отрицательна

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

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

AsynchronousCloseException — если другой поток закрывает этот канал во время выполнения операции записи

ClosedByInterruptException — если другой поток прерывает текущий поток во время выполнения операции записи, тем самым закрывая канал и устанавливая статус прерывания текущего потока

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

public abstract MappedByteBuffer map(FileChannel.MapMode mode, long position, long size) throws IOException

Параметры:

mode — одна из констант READ_ONLY, READ_WRITE или PRIVATE, определенных в классе FileChannel.MapMode, в зависимости от того, следует ли отобразить файл только для чтения, для чтения и записи или приватно (копирование при записи), соответственно; также может быть указан режим отображения, зависящий от реализации

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

size — размер отображаемой области; должен быть неотрицательным и не превышать Integer.MAX_VALUE

Возвращает:

Отображенный байтовый буфер

Выбрасывает:

NonReadableChannelException — если mode имеет значение READ_ONLY или указан зависящий от реализации режим отображения, требующий доступа для чтения, но этот канал не был открыт для чтения

NonWritableChannelException — если mode имеет значение READ_WRITE, PRIVATE или указан зависящий от реализации режим отображения, требующий доступа для записи, но этот канал не был открыт одновременно для чтения и записи

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

UnsupportedOperationException — если указан неподдерживаемый режим отображения

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

См. также:

• FileChannel.MapMode
• MappedByteBuffer

public MemorySegment map(FileChannel.MapMode mode, long offset, long size, Arena arena) throws IOException

Требования к реализации:

Реализация этого метода по умолчанию выбрасывает UnsupportedOperationException.

Примечание по реализации:

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

Параметры:

mode — режим отображения файла; см. map(FileChannel.MapMode, long, long); режим отображения может влиять на поведение возвращаемого сегмента отображенной памяти (см. MemorySegment.force())

offset — смещение (в байтах) в файле, с которого должен начинаться отображаемый сегмент

size — размер (в байтах) отображенной памяти, на которой основан сегмент памяти

arena — арена сегмента

Возвращает:

Новый сегмент отображенной памяти

Выбрасывает:

IllegalArgumentException — если offset < 0, size < 0 или offset + size выходит за пределы диапазона long

IllegalStateException — если arena.isAlive() == false

WrongThreadException — если arena является ареной с ограниченной областью действия, а этот метод вызывается из потока T, отличного от потока-владельца арены с ограниченной областью действия

NonReadableChannelException — если mode имеет значение READ_ONLY или указан зависящий от реализации режим отображения, требующий доступа для чтения, но этот канал не был открыт для чтения

NonWritableChannelException — если mode имеет значение READ_WRITE, PRIVATE или указан зависящий от реализации режим отображения, требующий доступа для записи, но этот канал не был открыт одновременно для чтения и записи

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

UnsupportedOperationException — если указан неподдерживаемый режим отображения

С версии:

22

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

Параметры:

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

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

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

Возвращает:

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

Выбрасывает:

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

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

AsynchronousCloseException — если другой поток закрывает этот канал, пока вызывающий поток заблокирован в этом методе

FileLockInterruptionException — если вызывающий поток прерывается, пока заблокирован в этом методе

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

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

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

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

См. также:

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

public final FileLock lock() throws IOException

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

Возвращает:

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

Выбрасывает:

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

AsynchronousCloseException — если другой поток закрывает этот канал, пока вызывающий поток заблокирован в этом методе

FileLockInterruptionException — если вызывающий поток прерывается, пока заблокирован в этом методе

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

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

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

См. также:

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

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()
• lock(long,long,boolean)
• tryLock()

public final FileLock tryLock() throws IOException

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

Возвращает:

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

Выбрасывает:

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

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

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

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

См. также:

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