Spec-Zone.ru › OpenJDK 25

Класс PushbackReader

java.lang.Object
java.io.Reader
java.io.FilterReader
java.io.PushbackReader
Все реализуемые интерфейсы:
Closeable, AutoCloseable, Readable
public class PushbackReader extends FilterReader
Потоковый символьный ридер, позволяющий возвращать символы обратно в поток.
Начиная с версии:
1.1

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

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

in

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

lock

Краткое описание конструкторов

Конструктор Описание
PushbackReader(Reader in)
Создает новый ридер с буфером возврата размером в один символ.
PushbackReader(Reader in, int size)
Создает новый ридер с буфером возврата заданного размера.

Краткое описание методов

Модификатор и тип Метод Описание
void close()
Закрывает поток и освобождает все связанные с ним системные ресурсы.
void mark(int readAheadLimit)
Отмечает текущую позицию в потоке.
boolean markSupported()
Сообщает, поддерживает ли этот поток операцию mark(), которую он не поддерживает.
int read()
Считывает один символ.
boolean ready()
Сообщает, готов ли этот поток к чтению.
void reset()
Сбрасывает поток.
void unread(char[] cbuf)
Возвращает массив символов обратно, копируя его в начало буфера возврата.
void unread(char[] cbuf, int off, int len)
Возвращает часть массива символов обратно, копируя ее в начало буфера возврата.
void unread(int c)
Возвращает один символ обратно, копируя его в начало буфера возврата.

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

read, skip

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

nullReader, of, read, read, readAllAsString, readAllLines, transferTo

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

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

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

PushbackReader

public PushbackReader(Reader in, int size)
Создает новый ридер с буфером возврата заданного размера.
Параметры:
in — ридер, из которого будут считываться символы
size — размер буфера возврата
Исключения:
IllegalArgumentException — если size <= 0

PushbackReader

public PushbackReader(Reader in)
Создает новый ридер с буфером возврата размером в один символ.
Параметры:
in — ридер, из которого будут считываться символы

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

read

public int read() throws IOException
Считывает один символ.
Переопределяет:
read в классе FilterReader
Возвращает:
Считанный символ или -1, если достигнут конец потока
Исключения:
IOException — если произошла ошибка ввода-вывода

unread

public void unread(int c) throws IOException
Возвращает один символ обратно, копируя его в начало буфера возврата. После завершения этого метода следующим будет считан символ со значением (char)c.
Параметры:
c — значение int, представляющее символ, который нужно вернуть обратно
Исключения:
IOException — если буфер возврата заполнен или произошла другая ошибка ввода-вывода

unread

public void unread(char[] cbuf, int off, int len) throws IOException
Возвращает часть массива символов обратно, копируя ее в начало буфера возврата. После завершения этого метода следующим будет считан символ со значением cbuf[off], за ним — символ со значением cbuf[off+1] и так далее.
Параметры:
cbuf — массив символов
off — смещение первого символа, который нужно вернуть обратно
len — количество символов, которые нужно вернуть обратно
Исключения:
IOException — если в буфере возврата недостаточно места или произошла другая ошибка ввода-вывода

unread

public void unread(char[] cbuf) throws IOException
Возвращает массив символов обратно, копируя его в начало буфера возврата. После завершения этого метода следующим будет считан символ со значением cbuf[0], за ним — символ со значением cbuf[1] и так далее.
Параметры:
cbuf — массив символов, который нужно вернуть обратно
Исключения:
IOException — если в буфере возврата недостаточно места или произошла другая ошибка ввода-вывода

ready

public boolean ready() throws IOException
Сообщает, готов ли этот поток к чтению.
Переопределяет:
ready в классе FilterReader
Возвращает:
true, если гарантируется, что следующий вызов read() не будет блокироваться в ожидании ввода; иначе false. Обратите внимание: возвращаемое значение false не гарантирует, что следующий вызов read будет заблокирован.
Исключения:
IOException — если произошла ошибка ввода-вывода

mark

public void mark(int readAheadLimit) throws IOException
Отмечает текущую позицию в потоке. Метод mark класса PushbackReader всегда генерирует исключение.
Переопределяет:
mark в классе FilterReader
Параметры:
readAheadLimit — ограничение на количество символов, которые можно считать с сохранением отметки. После считывания этого количества символов попытка сбросить поток может завершиться неудачей.
Исключения:
IOException — всегда, поскольку поддержка mark отсутствует

reset

public void reset() throws IOException
Сбрасывает поток. Метод reset класса PushbackReader всегда генерирует исключение.
Переопределяет:
reset в классе FilterReader
Исключения:
IOException — всегда, поскольку сброс не поддерживается

markSupported

public boolean markSupported()
Сообщает, поддерживает ли этот поток операцию mark(), которую он не поддерживает.
Переопределяет:
markSupported в классе FilterReader
Возвращает:
true тогда и только тогда, когда этот поток поддерживает операцию mark.

close

public void close() throws IOException
Закрывает поток и освобождает все связанные с ним системные ресурсы. После закрытия потока дальнейшие вызовы read(), unread(), ready() или skip() приведут к генерации IOException. Повторное закрытие уже закрытого потока не имеет эффекта. Этот метод будет блокироваться, пока другой поток заблокирован при работе с ридером.
Определено в:
close в интерфейсе AutoCloseable
Определено в:
close в интерфейсе Closeable
Определено в:
close в классе Reader
Исключения:
IOException — если произошла ошибка ввода-вывода

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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/PushbackReader.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API