Класс 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()`	Создает новый объект 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)`	Записать часть строки.

Методы, объявленные в классе 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 - целое число, определяющее символ для записи

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) ведет себя точно так же, как вызов

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 в интерфейсе Flushable
Указано в:: flush в классе Writer

close

public void close()
           throws IOException

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

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