Класс BufferedWriter

java.lang.Object

java.io.Writer

java.io.BufferedWriter

Все реализуемые интерфейсы:: Closeable, Flushable, Appendable, AutoCloseable

public class BufferedWriter extends Writer

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

Размер буфера может быть задан или может быть принят размер по умолчанию. Размер по умолчанию достаточно велик для большинства целей.

Предоставлен метод newLine(), который использует собственное представление платформы о разделителе строк, определённое системной переменной line.separator. Не все платформы используют символ новой строки ('\n') для завершения строк. Поэтому предпочтительнее вызывать этот метод для завершения каждой строки вывода, чем писать символ новой строки напрямую.

В общем случае, Writer сразу отправляет свой вывод в базовый поток символов или байтов. Если не требуется немедленный вывод, рекомендуется обернуть BufferedWriter вокруг любого Writer, операции write() которого могут быть дорогостоящими, например, FileWriters и OutputStreamWriters. Например,

 PrintWriter out
   = new PrintWriter(new BufferedWriter(new FileWriter("foo.out")));

будет буферизовать вывод PrintWriter в файл. Без буферизации каждый вызов метода print() приводил бы к преобразованию символов в байты, которые сразу же записывались бы в файл, что может быть очень неэффективно.

С момента:

1.1

См. также:

Краткое описание полей

Поля, объявленные в классе java.io.Writer

lock

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

Конструктор	Описание
`BufferedWriter(Writer out)`	Создаёт буферизованный поток символьного вывода, использующий буфер вывода по умолчанию.
`BufferedWriter(Writer out, int sz)`	Создаёт новый буферизованный поток символьного вывода, использующий буфер вывода заданного размера.

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает поток, предварительно его сбросив.
`void`	`flush()`	Сбрасывает поток.
`void`	`newLine()`	Записывает разделитель строк.
`void`	`write(char[] cbuf, int off, int len)`	Записывает часть массива символов.
`void`	`write(int c)`	Записывает одиночный символ.
`void`	`write(String s, int off, int len)`	Записывает часть строки.

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

append, append, append, nullWriter, write, write

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

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

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

BufferedWriter

public BufferedWriter(Writer out)

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

Параметры:: out - Writer

BufferedWriter

public BufferedWriter(Writer out, int sz)

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

Параметры:: out - Writer; sz - Размер буфера вывода, положительное целое число
Исключения:: IllegalArgumentException - Если sz <= 0

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

write

public void write(int c) throws IOException

Записывает одиночный символ.

Переопределяет:: write в классе Writer
Параметры:: c - целое число, задающее символ для записи
Исключения:: IOException - Если произошла ошибка ввода-вывода

write

public void write(char[] cbuf, int off, int len) throws IOException

Записывает часть массива символов.

Обычно этот метод записывает символы из заданного массива в буфер потока, сбрасывая буфер в базовый поток по мере необходимости. Однако, если запрошенная длина не меньше размера буфера, этот метод сбросит буфер и запишет символы непосредственно в базовый поток. Таким образом, избыточные BufferedWriter не будут копировать данные без необходимости.

Задано в:: write в классе Writer
Параметры:: cbuf - Массив символов; off - Смещение для начала чтения символов; len - Количество символов для записи
Исключения:: IndexOutOfBoundsException - Если off отрицательно, или len отрицательно, или off + len отрицательно или больше длины заданного массива; IOException - Если произошла ошибка ввода-вывода

write

public void write(String s, int off, int len) throws IOException

Записывает часть строки.

Переопределяет:: write в классе Writer
Требования к реализации:: Хотя спецификация этого метода в суперклассе рекомендует выбрасывать IndexOutOfBoundsException, если len отрицательно или off + len отрицательно, реализация в этом классе не выбрасывает исключения в этих случаях, а просто ничего не записывает.
Параметры:: s - Строка для записи; off - Смещение для начала чтения символов; len - Количество записываемых символов
Исключения:: IndexOutOfBoundsException - Если off отрицательно, или off + len больше длины заданной строки; IOException - Если произошла ошибка ввода-вывода

newLine

public void newLine() throws IOException

Записывает разделитель строк. Строка разделителя строк определяется системной переменной line.separator, и не обязательно является одиночным символом новой строки ('\n').

Исключения:: IOException - Если произошла ошибка ввода-вывода

flush

public void flush() throws IOException

Сбрасывает поток.

Задано в:: flush в интерфейсе Flushable
Задано в:: flush в классе Writer
Исключения:: IOException - Если произошла ошибка ввода-вывода

close

public void close() throws IOException

Описание скопировано из класса: Writer

Закрывает поток, предварительно его сбросив. После закрытия потока, дальнейшие вызовы write() или flush() приведут к сбрасыванию IOException. Закрытие уже закрытого потока не оказывает никакого влияния.

Задано в:: close в интерфейсе AutoCloseable
Задано в:: close в интерфейсе Closeable
Задано в:: close в классе Writer
Исключения:: IOException - Если произошла ошибка ввода-вывода

© 1993, 2021, 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/17/docs/api/java.base/java/io/BufferedWriter.html