Spec-Zone.ru › OpenJDK 8

Класс StringWriter

  • java.lang.Object
    • java.io.Writer
      • java.io.StringWriter
Все реализованные интерфейсы:
Closeable, Flushable, Appendable, AutoCloseable

public class StringWriter
extends Writer

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

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

С момента:
JDK1.1

Поля

Поля, унаследованные от класса java.io.Writer

lock

Конструкторы

Конструктор и описание
StringWriter()

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

StringWriter(int initialSize)

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

Методы

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

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 - Количество символов для записи

write

public void write(String str)

Записать строку.

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

write

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

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

Переопределяет:
write в классе Writer
Параметры:
str - Строка для записи
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, тогда четыре символа "null" добавляются в этот объект Writer.
Возвращает:
Этот объект 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 в интерфейсе Flushable
Задано:
flush в классе Writer

close

public void close()
           throws IOException

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

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

© 1993, 2020, 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.

Spec-Zone.ru

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