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

close

public void close() throws IOException

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

Определяет:: close в интерфейсе AutoCloseable
Определяет:: close в интерфейсе Closeable
Определяет:: close в классе Reader
Исключения:: IOException - если произошла ошибка ввода-вывода.

© 1993, 2023, 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/21/docs/api/java.base/java/io/PipedReader.html