Spec-Zone.ru › OpenJDK 25

Класс 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
См. также:
  • File
  • FileDescriptor
  • FileInputStream
  • Files.newOutputStream(Path, OpenOption...)

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

Конструктор Описание
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)
Записывает указанный байт в этот поток вывода в файл.

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

flush, nullOutputStream

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

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

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

FileOutputStream

public FileOutputStream(String name) throws FileNotFoundException
Создает поток вывода в файл для записи в файл с указанным именем. Если файл существует, его содержимое усекается; в противном случае создается новый файл. Символические ссылки автоматически перенаправляются на целевой объект ссылки. Создается новый объект FileDescriptor, представляющий это файловое соединение.

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

Требования к реализации:
Вызов этого конструктора с параметром name эквивалентен вызову new FileOutputStream(name, false).
Параметры:
name — зависящее от системы имя файла
Выбрасывает:
FileNotFoundException — если файл существует, но является каталогом, а не обычным файлом, не существует, но не может быть создан, или не может быть открыт по любой другой причине

FileOutputStream

public FileOutputStream(String name, boolean append) throws FileNotFoundException
Создает поток вывода в файл для записи в файл с указанным именем. Если файл существует, его содержимое усекается, если только второй аргумент не равен true; в этом случае байты записываются в конец файла, а не в его начало. Если файл не существует, он создается. Символические ссылки автоматически перенаправляются на целевой объект ссылки. Создается новый объект FileDescriptor, представляющий это файловое соединение.

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

Параметры:
name — зависящее от системы имя файла
append — если true, байты будут записываться в конец файла, а не в его начало
Выбрасывает:
FileNotFoundException — если файл существует, но является каталогом, а не обычным файлом, не существует, но не может быть создан, или не может быть открыт по любой другой причине.
С версии:
1.1

FileOutputStream

public FileOutputStream(File file) throws FileNotFoundException
Создает поток вывода в файл для записи в файл, представленный указанным объектом File. Если файл существует, его содержимое усекается; в противном случае создается новый файл. Символические ссылки автоматически перенаправляются на целевой объект ссылки. Создается новый объект FileDescriptor, представляющий это файловое соединение.

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

Параметры:
file — файл, который необходимо открыть для записи.
Выбрасывает:
FileNotFoundException — если файл существует, но является каталогом, а не обычным файлом, не существует, но не может быть создан, или не может быть открыт по любой другой причине
См. также:
  • File.getPath()

FileOutputStream

public FileOutputStream(File file, boolean append) throws FileNotFoundException
Создает поток вывода в файл для записи в файл, представленный указанным объектом File. Если файл существует, его содержимое усекается, если только второй аргумент не равен true; в этом случае байты записываются в конец файла, а не в его начало. Если файл не существует, он создается. Символические ссылки автоматически перенаправляются на целевой объект ссылки. Создается новый объект FileDescriptor, представляющий это файловое соединение.

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

Параметры:
file — файл, который необходимо открыть для записи.
append — если true, байты будут записываться в конец файла, а не в его начало
Выбрасывает:
FileNotFoundException — если файл существует, но является каталогом, а не обычным файлом, не существует, но не может быть создан, или не может быть открыт по любой другой причине
С версии:
1.4
См. также:
  • File.getPath()

FileOutputStream

public FileOutputStream(FileDescriptor fdObj)
Создает поток вывода в файл для записи в файл, представленный указанным дескриптором файла, который соответствует существующему соединению с фактическим файлом в файловой системе.

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

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

Параметры:
fdObj — дескриптор файла, который необходимо открыть для записи

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

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 — если происходит ошибка ввода-вывода.
См. также:
  • OutputStream.write(byte[], int, int)

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 — если происходит ошибка ввода-вывода.
См. также:
  • FileDescriptor

getChannel

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

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

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API