Класс FileOutputStream

java.lang.Object

java.io.OutputStream

java.io.FileOutputStream

Все реализованные интерфейсы:: Closeable, Flushable, AutoCloseable

public class FileOutputStream extends OutputStream

Поток вывода в файл — это поток вывода для записи данных в File или в FileDescriptor. Доступность файла или возможность его создания зависят от базовой платформы. Некоторые платформы, в частности, позволяют открыть файл для записи только одному FileOutputStream (или другому объекту записи в файл) за раз. В таких ситуациях конструкторы в этом классе будут работать некорректно, если файл уже открыт.

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

Примечание API:

Метод close() должен вызываться для освобождения ресурсов, используемых этим потоком, либо напрямую, либо с помощью инструкции try-with-resources.

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

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

С:

1.0

См. также:

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

Конструктор	Описание
`FileOutputStream(File file)`	Создаёт поток вывода в файл, представляемый заданным объектом `File`.
`FileOutputStream(FileDescriptor fdObj)`	Создаёт поток вывода в файл по заданному дескриптору файла, который представляет существующее соединение с фактическим файлом в файловой системе.
`FileOutputStream(File file, boolean append)`	Создаёт поток вывода в файл, представляемый заданным объектом `File`.
`FileOutputStream(String name)`	Создаёт поток вывода в файл с указанным именем.
`FileOutputStream(String name, boolean append)`	Создаёт поток вывода в файл с указанным именем.

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает этот поток вывода в файл и освобождает любые системные ресурсы, связанные с этим потоком.
`FileChannel`	`getChannel()`	Возвращает уникальный объект `FileChannel`, связанный с этим потоком вывода в файл.
`final FileDescriptor`	`getFD()`	Возвращает дескриптор файла, связанный с этим потоком.
`void`	`write(byte[] b)`	Записывает `b.length` байта из указанного массива байтов в этот поток вывода в файл.
`void`	`write(byte[] b, int off, int len)`	Записывает `len` байта из указанного массива байтов, начиная с смещения `off`, в этот поток вывода в файл.
`void`	`write(int b)`	Записывает указанный байт в этот поток вывода в файл.

Методы, объявленные в классе java.io.OutputStream

flush, nullOutputStream

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

FileOutputStream

public FileOutputStream(String name) throws FileNotFoundException

Создаёт поток вывода в файл с указанным именем. Новый объект FileDescriptor создаётся для представления этого файлового соединения.

Сначала, если есть менеджер безопасности, вызывается его метод checkWrite с аргументом name.

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

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

Вызов этого конструктора с параметром name эквивалентен вызову new FileOutputStream(name, false).

Параметры:

name - имя файла, зависящее от операционной системы

Исключения:

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

SecurityException - если менеджер безопасности существует и его метод checkWrite запрещает доступ для записи в файл.

См. также:

FileOutputStream

public FileOutputStream(String name, boolean append) throws FileNotFoundException

Создаёт поток вывода в файл с указанным именем. Если второй аргумент true, то байты будут записаны в конец файла, а не в начало. Новый объект FileDescriptor создаётся для представления этого файлового соединения.

Сначала, если есть менеджер безопасности, вызывается его метод checkWrite с аргументом name.

Параметры:

name - имя файла, зависящее от операционной системы

append - если true, то байты будут записаны в конец файла, а не в начало

Исключения:

SecurityException - если менеджер безопасности существует и его метод checkWrite запрещает доступ для записи в файл.

С момента:

1.1

См. также:

FileOutputStream

public FileOutputStream(File file) throws FileNotFoundException

Создаёт поток вывода в файл, представленный указанным объектом File. Новый объект FileDescriptor создаётся для представления этого файлового соединения.

Сначала, если есть менеджер безопасности, вызывается его метод checkWrite с путём, представленным аргументом file, в качестве аргумента.

Параметры:

file - файл, подлежащий открытию для записи.

Исключения:

SecurityException - если менеджер безопасности существует и его метод checkWrite запрещает доступ для записи в файл.

См. также:

FileOutputStream

public FileOutputStream(File file, boolean append) throws FileNotFoundException

Создаёт поток вывода в файл, представленный указанным объектом File. Если второй аргумент true, то байты будут записаны в конец файла, а не в начало. Новый объект FileDescriptor создаётся для представления этого файлового соединения.

Параметры:

file - файл, подлежащий открытию для записи.

append - если true, то байты будут записаны в конец файла, а не в начало

Исключения:

SecurityException - если менеджер безопасности существует и его метод checkWrite запрещает доступ для записи в файл.

С момента:

1.4

См. также:

FileOutputStream

public FileOutputStream(FileDescriptor fdObj)

Создаёт поток вывода в указанный дескриптор файла, который представляет собой существующее соединение с фактическим файлом в файловой системе.

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

Если fdObj равно null, то выбрасывается NullPointerException.

Этот конструктор не выбрасывает исключение, если fdObj является invalid. Однако, если методы вызываются в результирующем потоке для попытки ввода-вывода в потоке, выбрасывается IOException.

Параметры:

fdObj - дескриптор файла, подлежащий открытию для записи

Исключения:

SecurityException - если менеджер безопасности существует и его метод checkWrite запрещает доступ для записи к дескриптору файла

См. также:

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

write

public void write(int b) throws IOException

Записывает указанный байт в этот поток вывода в файл. Реализует метод write класса OutputStream.

Определено в:: write в классе OutputStream
Параметры:: b - байт, который необходимо записать.
Исключения:: IOException - если произошла ошибка ввода-вывода.

write

public void write(byte[] b) throws IOException

Записывает b.length байтов из указанного массива байтов в этот поток вывода в файл.

Переопределяет:

write в классе OutputStream

Параметры:

b - данные.

Исключения:

IOException - если произошла ошибка ввода-вывода.

См. также:

write

public void write(byte[] b, int off, int len) throws IOException

Записывает len байтов из указанного массива байтов, начиная с смещения off, в этот поток вывода в файл.

Переопределяет:: write в классе OutputStream
Параметры:: b - данные.; off - начальное смещение в данных.; len - количество байтов для записи.
Исключения:: IOException - если произошла ошибка ввода-вывода.; IndexOutOfBoundsException - Если off отрицательно, len отрицательно или len больше, чем b.length - off

close

public void close() throws IOException

Закрывает этот поток вывода в файл и освобождает все системные ресурсы, связанные с этим потоком. Этот поток вывода в файл больше не может использоваться для записи байтов.

Если у этого потока есть связанный канал, то канал также закрывается.

Определено в:: close в интерфейсе AutoCloseable
Определено в:: close в интерфейсе Closeable
Переопределяет:: close в классе OutputStream
Примечание API:: Переопределение close() для выполнения действий по очистке надежно только при прямом вызове или при вызове с помощью try-with-resources.
Требования к реализации:: Подклассы, требующие, чтобы очистка ресурсов происходила после того, как поток станет недоступным, должны использовать механизм Cleaner.
Если у этого потока есть связанный канал, то этот метод закроет канал, который в свою очередь закроет этот поток. Подклассы, переопределяющие этот метод, должны быть готовы к обработке возможного повторного вызова.
Исключения:: IOException - если произошла ошибка ввода-вывода.

getFD

public final FileDescriptor getFD() throws IOException

Возвращает дескриптор файла, связанный с этим потоком.

Возвращает:

объект FileDescriptor, представляющий соединение с файлом в файловой системе, используемое этим объектом FileOutputStream.

Исключение:

IOException - если произошла ошибка ввода-вывода.

См. также:

getChannel

public FileChannel getChannel()

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

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

Возвращает:: канал файла, связанный с этим файловым потоком вывода
С момента:: 1.4

© 1993, 2023, 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/21/docs/api/java.base/java/io/FileOutputStream.html