Класс PipedReader

java.lang.Object

java.io.Reader

java.io.PipedReader

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

public class PipedReader extends Reader

Потоковые потоки символьного ввода.

С момента:: 1.1

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

Поля, объявленные в классе java.io.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()`	Указывает, готов ли этот поток к чтению.

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

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

Методы, объявленные в классе java.lang.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
Возвращает:: True, если следующее чтение гарантированно не заблокируется для ввода, 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/io/PipedReader.html