Класс Writer

java.lang.Object

java.io.Writer

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

Непосредственные известные подклассы:: BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, PipedWriter, PrintWriter, StringWriter

public abstract class Writer extends Object implements Appendable, Closeable, Flushable

Абстрактный класс для записи в потоки символов. Подкласс должен реализовать только методы write(char[], int, int), flush() и close(). Однако большинство подклассов переопределяют некоторые методы, определённые здесь, для повышения эффективности, добавления функциональности или того и другого.

С момента:

1.1

См. также:

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

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

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

Writer()

Writer(Object lock)

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

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

Модификатор и тип	Метод	Описание
`Writer`	`append(char c)`	Добавляет указанный символ к этому писателю.
`Writer`	`append(CharSequence csq)`	Добавляет указанную последовательность символов к этому писателю.
`Writer`	`append(CharSequence csq, int start, int end)`	Добавляет подпоследовательность указанной последовательности символов к этому писателю.
`abstract void`	`close()`	Закрывает поток, предварительно его сбросив.
`abstract void`	`flush()`	Сбрасывает поток.
`static Writer`	`nullWriter()`	Возвращает новый `Writer`, который отбрасывает все символы.
`void`	`write(char[] cbuf)`	Записывает массив символов.
`abstract 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.lang.Object

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

Подробное описание полей

lock

protected Object lock

Объект, используемый для синхронизации операций с этим потоком. Для повышения эффективности объект потока символов может использовать другой объект для защиты критических секций. Поэтому подкласс должен использовать объект в этом поле, а не this или синхронизированный метод.

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

Writer

protected Writer()

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

Writer

protected Writer(Object lock)

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

Параметры:: lock - Объект для синхронизации

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

nullWriter

public static Writer nullWriter()

Возвращает новый Writer, который игнорирует все символы. Возвращаемый поток изначально открыт. Поток закрывается вызовом метода close(). Последующие вызовы метода close() не имеют эффекта.

Пока поток открыт, методы append(char), append(CharSequence), append(CharSequence, int, int), flush(), write(int), write(char[]), и write(char[], int, int) ничего не делают. После закрытия потока эти методы выбрасывают исключение IOException.

Объект object, используемый для синхронизации операций с возвращаемым Writer, не определён.

Возвращает:: объект Writer который игнорирует все символы
С:: 11

write

public void write(int c) throws IOException

Записывает один символ. Записываемый символ содержится в 16 младших битах данного целочисленного значения; 16 старших битов игнорируются.

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

Параметры:: c - целое число, представляющее символ для записи
Исключения:: IOException - Если произошла ошибка ввода/вывода

write

public void write(char[] cbuf) throws IOException

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

Параметры:: cbuf - Массив символов для записи
Исключения:: IOException - Если произошла ошибка ввода/вывода

write

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

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

Параметры:: cbuf - Массив символов; off - Смещение для начала записи символов; len - Количество символов для записи
Исключения:: IndexOutOfBoundsException - Реализации должны выбрасывать это исключение, если off отрицательно, или len отрицательно, или off + len отрицательно или больше длины данного массива; IOException - Если произошла ошибка ввода/вывода

write

public void write(String str) throws IOException

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

Параметры:: str - Строка для записи
Исключения:: IOException - Если произошла ошибка ввода/вывода

write

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

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

Требования к реализации:: Реализация в этом классе выбрасывает IndexOutOfBoundsException для указанных условий; переопределяющие методы могут выбрать другое поведение.
Параметры:: str - Строка; off - Смещение для начала записи символов; len - Количество символов для записи
Исключения:: IndexOutOfBoundsException - Реализации должны выбрасывать это исключение, если off отрицательно, или len отрицательно, или off + len отрицательно или больше длины заданной строки; IOException - Если произошла ошибка ввода/вывода

append

public Writer append(CharSequence csq) throws IOException

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

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

     out.write(csq.toString())

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

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

append

public Writer append(CharSequence csq, int start, int end) throws IOException

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

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


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

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

append

public Writer append(char c) throws IOException

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

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

     out.write(c)

Унаследовано от:: append в интерфейсе Appendable
Параметры:: c - 16-битный символ для добавления
Возвращает:: Этот объект Writer
Исключения:: IOException - Если произошла ошибка ввода/вывода
С:: 1.5

flush

public abstract void flush() throws IOException

Очищает поток. Если поток сохранил какие-либо символы из различных методов write() в буфере, запишите их немедленно в их предполагаемое место назначения. Затем, если это место назначения является другим потоком символов или байтов, очистите его. Таким образом, один вызов flush() очистит все буферы в цепочке объектов Writer и OutputStream.

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

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

close

public abstract void close() throws IOException

Закрывает поток, предварительно очистив его. После закрытия потока дальнейшие вызовы write() или flush() приведут к тому, что будет выброшено исключение IOException. Закрытие ранее закрытого потока не имеет эффекта.

Унаследовано от:: close в интерфейсе AutoCloseable
Унаследовано от:: close в интерфейсе Closeable
Исключения:: 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/Writer.html