Класс PipedReader

java.lang.Object

java.io.Reader

java.io.PipedReader

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

public class PipedReader extends Reader

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

Начиная с:: 1.1

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

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

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

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

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

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

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
Возвращает:: Истина, если следующий вызов read() гарантированно не будет блокироваться в ожидании входных данных; в противном случае — ложь. Обратите внимание: возвращаемое значение false не гарантирует, что следующий вызов read будет блокироваться.
Вызывает исключения:: 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/PipedReader.html