Класс StringWriter

java.lang.Object

java.io.Writer

java.io.StringWriter

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

public class StringWriter extends Writer

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

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

С тех пор:: 1.1

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

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

lock

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

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

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

Модификатор и тип	Метод	Описание
`StringWriter`	`append(char c)`	Добавляет указанный символ в этот writer.
`StringWriter`	`append(CharSequence csq)`	Добавляет указанную последовательность символов в этот writer.
`StringWriter`	`append(CharSequence csq, int start, int end)`	Добавляет подпоследовательность указанной последовательности символов в этот writer.
`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)`	Записать часть строки.

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

nullWriter, write

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

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

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

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)

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

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

     out.write(csq.toString())

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

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

append

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

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

Вызов этого метода в форме 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 - Индекс символа, следующего за последним символом в подпоследовательности
Возвращает:: Этот объект Writer
Исключения:: IndexOutOfBoundsException - Если start или end отрицательны, start больше end, или end больше csq.length()
С тех пор:: 1.5

append

public StringWriter append(char c)

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

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

     out.write(c)

Определено в:: append в интерфейсе Appendable
Переопределяет:: append в классе Writer
Параметры:: c - Символ (16-битный) для добавления
Возвращает:: Этот объект Writer
С тех пор:: 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

Закрытие объекта StringWriter не имеет эффекта. Методы в этом классе могут вызываться после закрытия потока без генерации 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/StringWriter.html