Класс 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)`	Считывает до `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 символов данных из этого потокового потока в массив символов. Менее чем len символов будут считаны, если достигнут конец потока данных или если len превышает размер буфера трубы. Этот метод блокируется, пока хотя бы один символ ввода не станет доступным.

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

ready

public boolean ready()
              throws IOException

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

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

close

public void close()
           throws IOException

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

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