Класс FileOutputStream
- Все реализуемые интерфейсы:
Closeable, Flushable, AutoCloseable
public class FileOutputStream extends OutputStream
File или в FileDescriptor. Доступность файла и возможность его создания зависят от используемой платформы. Некоторые платформы, в частности, позволяют открывать файл для записи только одному FileOutputStream (или другому объекту для записи в файл) одновременно. В таких случаях конструкторы этого класса завершаются с ошибкой, если соответствующий файл уже открыт. FileOutputStream предназначен для записи потоков необработанных байтов, например данных изображения. Для записи потоков символов рекомендуется использовать FileWriter.
- Примечание API:
- Для освобождения ресурсов, используемых этим потоком, следует вызвать метод
close()напрямую или использовать операторtry-with-resources. - Требования к реализации:
- Подклассы отвечают за очистку ресурсов, полученных подклассом. Подклассам, которым необходимо выполнять очистку ресурсов после того, как поток станет недостижимым, следует использовать
Cleanerили другой механизм. - С версии:
- 1.0
- См. также:
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
FileOutputStream |
Создает поток вывода в файл для записи в файл, представленный указанным объектом File. |
FileOutputStream |
Создает поток вывода в файл для записи в указанный дескриптор файла, представляющий существующее соединение с реальным файлом в файловой системе. |
FileOutputStream |
Создает поток вывода в файл для записи в файл, представленный указанным объектом File. |
FileOutputStream |
Создает поток вывода в файл для записи в файл с указанным именем. |
FileOutputStream |
Создает поток вывода в файл для записи в файл с указанным именем. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
close() |
Закрывает этот поток вывода в файл и освобождает все системные ресурсы, связанные с этим потоком. |
FileChannel |
getChannel() |
Возвращает уникальный объект FileChannel, связанный с этим потоком вывода в файл. |
final FileDescriptor |
getFD() |
Возвращает дескриптор файла, связанный с этим потоком. |
void |
write |
Записывает b.length байтов из указанного массива байтов в этот поток вывода в файл. |
void |
write |
Записывает len байтов из указанного массива байтов, начиная со смещения off, в этот поток вывода в файл. |
void |
write |
Записывает указанный байт в этот поток вывода в файл. |
Методы, объявленные в классе OutputStream
flush, nullOutputStream | Модификатор и тип | Метод | Описание |
|---|---|---|
void |
flush() |
Сбрасывает этот поток вывода и принудительно записывает все буферизованные выходные байты. |
static OutputStream |
nullOutputStream() |
Возвращает новый OutputStream, отбрасывающий все байты. |
Методы, объявленные в классе Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | Модификатор и тип | Метод | Описание |
|---|---|---|
protected Object |
clone() |
Создает и возвращает копию этого объекта. |
boolean |
equals |
Показывает, равен ли какой-либо другой объект этому объекту. |
protected void |
finalize() |
Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков. |
final Class |
getClass() |
Возвращает класс среды выполнения этого Object. |
int |
hashCode() |
Возвращает значение хеш-кода для этого объекта. |
final void |
notify() |
Пробуждает один поток, ожидающий на мониторе этого объекта. |
final void |
notifyAll() |
Пробуждает все потоки, ожидающие на мониторе этого объекта. |
String |
toString() |
Возвращает строковое представление объекта. |
final void |
wait() |
Заставляет текущий поток ожидать до тех пор, пока он не будет пробужден, обычно в результате вызова notify или прерывания. |
final void |
wait |
Заставляет текущий поток ожидать до тех пор, пока он не будет пробужден, обычно в результате вызова notify или прерывания, либо пока не пройдет определенное время. |
final void |
wait |
Заставляет текущий поток ожидать до тех пор, пока он не будет пробужден, обычно в результате вызова notify или прерывания, либо пока не пройдет определенное время. |
Подробное описание конструкторов
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— если файл существует, но является каталогом, а не обычным файлом, не существует и не может быть создан или не может быть открыт по какой-либо другой причине - См. также:
FileOutputStream
public FileOutputStream(File file, boolean append) throws FileNotFoundException
File. Если файл существует, его содержимое усекается, если только второй аргумент не равен true; в этом случае байты будут записываться в конец файла, а не в его начало. Если файл не существует, он создается. Символические ссылки автоматически перенаправляются на целевой объект ссылки. Для представления этого файлового соединения создается новый объект FileDescriptor. Если файл существует, но является каталогом, а не обычным файлом, не существует и не может быть создан или не может быть открыт по какой-либо другой причине, выбрасывается FileNotFoundException.
- Параметры:
-
file— файл, который следует открыть для записи. -
append— еслиtrue, байты будут записываться в конец файла, а не в его начало - Исключения:
-
FileNotFoundException— если файл существует, но является каталогом, а не обычным файлом, не существует и не может быть создан или не может быть открыт по какой-либо другой причине - С версии:
- 1.4
- См. также:
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— при возникновении ошибки ввода-вывода. - См. также:
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, 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.