Spec-Zone.ru › OpenJDK 21

Класс 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
См. также:
  • PrintWriter
  • FileWriter
  • OutputStreamWriter
  • Files.newBufferedWriter(java.nio.file.Path, java.nio.charset.Charset, java.nio.file.OpenOption...)

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

Поля, объявленные в классе 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 - int, определяющий символ для записи
Исключения:
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, 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/BufferedWriter.html

Spec-Zone.ru

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