Класс 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, 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, если следующий вызов read() гарантированно не будет блокироваться для ввода, false в противном случае. Обратите внимание, что возврат false не гарантирует, что следующий вызов read() заблокируется.
Исключения:: IOException - если труба broken, unconnected или закрыта.

close

public void close() throws IOException

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

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