Класс PipedReader

java.lang.Object

java.io.Reader

java.io.PipedReader

Все реализуемые интерфейсы:: Closeable, AutoCloseable, Readable

public class PipedReader extends Reader

Потоки ввода символов через канал.

Начиная с:: 1.1

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

Поля, объявленные в классе Reader

lock

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

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

Конструктор	Описание
`PipedReader()`	Создает `PipedReader`, которое пока не подключено.
`PipedReader(int pipeSize)`	Создает `PipedReader`, которое пока не `connected`, и задает указанный размер буфера канала.
`PipedReader(PipedWriter src)`	Создает `PipedReader`, подключенное к писателю канала `src`.
`PipedReader(PipedWriter src, int pipeSize)`	Создает `PipedReader`, подключенное к писателю канала `src`, и задает указанный размер буфера канала.

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает этот поток через канал и освобождает все системные ресурсы, связанные с ним.
`void`	`connect(PipedWriter src)`	Подключает этот читатель канала к писателю канала `src`.
`int`	`read()`	Читает следующий символ данных из этого потока через канал.
`int`	`read(char[] cbuf, int off, int len)`	Читает символы в часть массива.
`boolean`	`ready()`	Проверяет, готов ли этот поток к чтению.

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

mark, markSupported, nullReader, of, read, read, readAllAsString, readAllLines, reset, skip, transferTo

Модификатор и тип	Метод	Описание
`void`	`mark(int readAheadLimit)`	Помечает текущую позицию в потоке.
`boolean`	`markSupported()`	Проверяет, поддерживает ли этот поток операцию mark().
`static Reader`	`nullReader()`	Возвращает новый `Reader`, который не читает символов.
`static Reader`	`of(CharSequence cs)`	Возвращает `Reader`, который читает символы из `CharSequence`.
`int`	`read(char[] cbuf)`	Читает символы в массив.
`int`	`read(CharBuffer target)`	Пытается прочитать символы в указанный буфер символов.
`String`	`readAllAsString()`	Читает все оставшиеся символы в строку.
`List<String>`	`readAllLines()`	Читает все оставшиеся символы как строки текста.
`void`	`reset()`	Сбрасывает поток.
`long`	`skip(long n)`	Пропускает символы.
`long`	`transferTo(Writer out)`	Читает все символы из этого средства чтения и записывает их в указанный писатель в том порядке, в котором они были прочитаны.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать до пробуждения, обычно посредством вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать до пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать до пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

PipedReader

public PipedReader(PipedWriter src) throws IOException

Создает PipedReader, подключенное к писателю канала src. Данные, записанные в src, будут доступны для чтения из этого потока.

Параметры:: src — поток для подключения.
Исключения:: IOException — если возникает ошибка ввода-вывода.

PipedReader

public PipedReader(PipedWriter src, int pipeSize) throws IOException

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

Параметры:: src — поток для подключения.; pipeSize — размер буфера канала.
Исключения:: IOException — если возникает ошибка ввода-вывода.; IllegalArgumentException — если pipeSize <= 0.
Начиная с:: 1.6

PipedReader

public PipedReader()

Создает PipedReader, которое пока не подключено. Перед использованием его необходимо подключить к PipedWriter.

PipedReader

public PipedReader(int pipeSize)

Создает PipedReader, которое пока не connected, и задает указанный размер буфера канала. Перед использованием его необходимо подключить к PipedWriter.

Параметры:: pipeSize — размер буфера канала.
Исключения:: IllegalArgumentException — если pipeSize <= 0.
Начиная с:: 1.6

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

connect

public void connect(PipedWriter src) throws IOException

Подключает этот читатель канала к писателю канала src. Если этот объект уже подключен к другому писателю канала, выбрасывается IOException.

Если src — неподключенный писатель канала, а snk — неподключенный читатель канала, их можно подключить одним из следующих вызовов:

    snk.connect(src)

или вызовом:

    src.connect(snk)

Оба вызова имеют одинаковый результат.

Параметры:: src — писатель канала для подключения.
Исключения:: IOException — если возникает ошибка ввода-вывода.

read

public int read() throws IOException

Читает следующий символ данных из этого потока через канал. Если символ недоступен, поскольку достигнут конец потока, возвращается значение -1. Этот метод блокирует выполнение до появления входных данных, обнаружения конца потока или возникновения исключения.

Переопределяет:: read в классе Reader
Возвращает:: следующий символ данных или -1, если достигнут конец потока.
Исключения:: IOException — если канал broken, unconnected, закрыт или возникает ошибка ввода-вывода.

read

public int read(char[] cbuf, int off, int len) throws IOException

Читает символы в часть массива. Этот метод блокирует выполнение до появления входных данных, возникновения ошибки ввода-вывода или достижения конца потока.

Если len равно нулю, символы не читаются и возвращается 0; в противном случае предпринимается попытка прочитать хотя бы один символ. Если символы недоступны, поскольку достигнут конец потока, возвращается значение -1; иначе читается и сохраняется в cbuf как минимум один символ.

Будет прочитано меньше len символов, если len превышает размер буфера канала.

Определено:: read в классе Reader
Параметры:: cbuf — буфер назначения; off — смещение, с которого начинается сохранение символов; len — максимальное число символов для чтения
Возвращает:: число прочитанных символов или -1, если достигнут конец потока
Исключения:: IndexOutOfBoundsException — если off отрицательно, либо len отрицательно, либо len больше cbuf.length - off; IOException — если канал broken, unconnected, закрыт или возникает ошибка ввода-вывода.

ready

public boolean ready() throws IOException

Проверяет, готов ли этот поток к чтению. Поток символов через канал готов к чтению, если кольцевой буфер не пуст.

Переопределяет:: ready в классе Reader
Возвращает:: true, если следующая операция read() гарантированно не будет блокироваться в ожидании входных данных, иначе false. Обратите внимание: возврат false не гарантирует, что следующая операция чтения будет блокироваться.
Исключения:: IOException — если канал broken, unconnected или закрыт.

close

public void close() throws IOException

Закрывает этот поток через канал и освобождает все системные ресурсы, связанные с ним.

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