Класс 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

Модификатор и тип	Поле	Описание
`protected Object`	`lock`	Объект, используемый для синхронизации операций над этим потоком.

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

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

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

Модификатор и тип	Метод	Описание
`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

Модификатор и тип	Метод	Описание
`static Writer`	`nullWriter()`	Возвращает новый `Writer`, отбрасывающий все символы.
`void`	`write(char[] cbuf)`	Записывает массив символов.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, подлежит удалению: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

StringWriter

public StringWriter()

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

StringWriter

public StringWriter(int initialSize)

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

Параметры:: 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.