Класс StringWriter

java.lang.Object

java.io.Writer

java.io.StringWriter

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

public class StringWriter extends Writer

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

Закрытие StringWriter не оказывает никакого эффекта. Методы этого класса можно вызывать после закрытия потока без возникновения IOException.

С версии:: 1.1

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

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

lock

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

Конструктор	Описание
`StringWriter()`	Создает новый объект для записи строк, используя размер строкового буфера по умолчанию.
`StringWriter(int initialSize)`	Создает новый объект для записи строк, используя заданный начальный размер строкового буфера.

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

Модификатор и тип	Метод	Описание
`StringWriter`	`append(char c)`	Добавляет указанный символ в этот объект для записи.
`StringWriter`	`append(CharSequence csq)`	Добавляет указанную последовательность символов в этот объект для записи.
`StringWriter`	`append(CharSequence csq, int start, int end)`	Добавляет подстроку указанной последовательности символов в этот объект для записи.
`void`	`close()`	Закрытие `StringWriter` не оказывает никакого эффекта.
`void`	`flush()`	Сбрасывает поток.
`StringBuffer`	`getBuffer()`	Возвращает сам строковый буфер.
`String`	`toString()`	Возвращает текущее содержимое буфера в виде строки.
`void`	`write(char[] cbuf, int off, int len)`	Записывает часть массива символов.
`void`	`write(int c)`	Записывает один символ.
`void`	`write(String str)`	Записывает строку.
`void`	`write(String str, int off, int len)`	Записывает часть строки.

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

nullWriter, write

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

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

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

StringWriter

public StringWriter()

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

StringWriter

public StringWriter(int initialSize)

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

Параметры:: initialSize — количество значений char, которое поместится в этот буфер до его автоматического увеличения
Исключения:: IllegalArgumentException — если initialSize отрицательно

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

write

public void write(int c)

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

Переопределяет:: write в классе Writer
Параметры:: c — int, задающий записываемый символ

write

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

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

Определено в:: write в классе Writer
Параметры:: cbuf — массив символов; off — смещение, с которого начинается запись символов; len — количество записываемых символов
Исключения:: IndexOutOfBoundsException — если off отрицательно, или len отрицательно, или off + len отрицательно либо больше длины заданного массива

write

public void write(String str)

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

Переопределяет:: write в классе Writer
Параметры:: str — записываемая строка

write

public void write(String str, int off, int len)

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

Переопределяет:: write в классе Writer
Параметры:: str — записываемая строка; off — смещение, с которого начинается запись символов; len — количество записываемых символов
Исключения:: IndexOutOfBoundsException — если off отрицательно, или len отрицательно, или off + len отрицательно либо больше длины заданной строки

append

public StringWriter append(CharSequence csq)

Добавляет указанную последовательность символов в этот объект для записи.

Вызов этого метода в форме out.append(csq), когда csq не является null, ведет себя точно так же, как вызов

    out.write(csq.toString())

В зависимости от спецификации toString для последовательности символов csq, последовательность может быть добавлена не целиком. Например, вызов метода toString буфера символов вернет подстроку, содержимое которой зависит от позиции и предела буфера.

Определено в:: append в интерфейсе Appendable
Переопределяет:: append в классе Writer
Параметры:: csq — последовательность символов для добавления. Если csq равно null, этот объект для записи дополнится четырьмя символами "null".
Возвращает:: этот объект для записи
С версии:: 1.5

append

public StringWriter append(CharSequence csq, int start, int end)

Добавляет подстроку указанной последовательности символов в этот объект для записи.

Вызов этого метода в форме out.append(csq, start, end), когда csq не является null, ведет себя точно так же, как вызов

    out.write(csq.subSequence(start, end).toString())

Определено в:: append в интерфейсе Appendable
Переопределяет:: append в классе Writer
Параметры:: csq — последовательность символов, из которой будет добавлена подстрока. Если csq равно null, символы будут добавлены так, как если бы csq содержал четыре символа "null".; start — индекс первого символа подстроки; end — индекс символа, следующего за последним символом подстроки
Возвращает:: этот объект для записи
Исключения:: IndexOutOfBoundsException — если start или end отрицательны, start больше end или end больше csq.length()
С версии:: 1.5

append

public StringWriter append(char c)

Добавляет указанный символ в этот объект для записи.

Вызов этого метода в форме out.append(c) ведет себя точно так же, как вызов

    out.write(c)

Определено в:: append в интерфейсе Appendable
Переопределяет:: append в классе Writer
Параметры:: c — 16-разрядный символ для добавления
Возвращает:: этот объект для записи
С версии:: 1.5

toString

public String toString()

Возвращает текущее содержимое буфера в виде строки.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта

getBuffer

public StringBuffer getBuffer()

Возвращает сам строковый буфер.

Возвращает:: StringBuffer, содержащий текущее значение буфера.

flush

public void flush()

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

Метод flush класса StringWriter ничего не делает.

Определено в:: flush в интерфейсе Flushable
Определено в:: flush в классе Writer

close

public void close() throws IOException

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

© 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/StringWriter.html