Класс Reader

public abstract class Reader
extends Object
implements Readable, Closeable

Поля

lock

protected Object lock

Объект, используемый для синхронизации операций с этим потоком. Для повышения эффективности объект потока символов может использовать объект, отличный от самого себя, для защиты критических секций. Следовательно, подкласс должен использовать объект в этом поле, а не this или синхронизированный метод.

Конструкторы

Reader

protected Reader()

Создает новый читатель потока символов, чьи критические секции будут синхронизироваться на самом читателе.

Reader

protected Reader(Object lock)

Создает новый читатель потока символов, чьи критические секции будут синхронизироваться на заданном объекте.

Параметры:

lock - Объект для синхронизации.

Методы

read

public int read(CharBuffer target)
         throws IOException

Пытается прочитать символы в указанный буфер символов. Буфер используется как хранилище символов как есть: единственные изменения — результаты операции put. Никакой переворота или перемотки буфера не производится.

Задано:

read в интерфейсе Readable

Параметры:

target - буфер для чтения символов

Возвращает:

Количество символов, добавленных в буфер, или -1, если этот источник символов достиг своего конца

Исключения:

IOException - если произошла ошибка ввода/вывода

NullPointerException - если целевой объект равен null

ReadOnlyBufferException - если целевой объект является только для чтения

С момента:

1.5

read

public int read()
         throws IOException

Возвращает:

Прочитанный символ, как целое число в диапазоне от 0 до 65535 (0x00-0xffff), или -1, если достигнут конец потока

Исключения:

IOException - Если произошла ошибка ввода/вывода

read

public int read(char[] cbuf)
         throws IOException

Читает символы в массив. Этот метод будет блокироваться до тех пор, пока некоторые данные не будут доступны, не произойдет ошибка ввода/вывода или не будет достигнут конец потока.

Параметры:

cbuf - Буфер назначения

Возвращает:

Количество прочитанных символов, или -1, если достигнут конец потока

Исключения:

IOException - Если произошла ошибка ввода/вывода

read

public abstract int read(char[] cbuf,
                         int off,
                         int len)
                  throws IOException

Читает символы в часть массива. Этот метод будет блокироваться до тех пор, пока некоторые данные не будут доступны, не произойдет ошибка ввода/вывода или не будет достигнут конец потока.

Параметры:

cbuf - Буфер назначения

off - Смещение, с которого начать хранение символов

len - Максимальное количество символов для чтения

Возвращает:

Количество прочитанных символов, или -1, если достигнут конец потока

Исключения:

IOException - Если произошла ошибка ввода/вывода

skip

public long skip(long n)
          throws IOException

Пропускает символы. Этот метод будет блокироваться до тех пор, пока некоторые символы не будут доступны, не произойдет ошибка ввода/вывода или не будет достигнут конец потока.

Параметры:

n - Количество символов для пропуска

Возвращает:

Количество фактически пропущенных символов

Исключения:

IllegalArgumentException - Если n отрицательно.

IOException - Если произошла ошибка ввода/вывода

ready

public boolean ready()
              throws IOException

Указывает, готов ли этот поток к чтению.

Возвращает:

true, если следующий вызов read() гарантированно не заблокируется в ожидании ввода, иначе false. Обратите внимание, что возвращение false не гарантирует, что следующий вызов read() заблокируется.

Исключения:

IOException - Если произошла ошибка ввода/вывода

markSupported

public boolean markSupported()

Указывает, поддерживает ли этот поток операцию mark(). По умолчанию реализация всегда возвращает false. Подклассы должны переопределить этот метод.

Возвращает:

true, если и только если этот поток поддерживает операцию mark.

mark

public void mark(int readAheadLimit)
          throws IOException

Помечает текущую позицию в потоке. Последующие вызовы reset() будут пытаться переместить поток в эту точку. Не все потоки ввода символов поддерживают операцию mark().

Параметры:

readAheadLimit - Предел количества символов, которые можно прочитать, сохраняя метку. После чтения этого количества символов попытка сброса потока может завершиться неудачей.

Исключения:

IOException - Если поток не поддерживает mark(), или произошла другая ошибка ввода/вывода

reset

public void reset()
           throws IOException

Сбрасывает поток. Если поток был помечен, то попытайтесь переместить его в точку метки. Если поток не был помечен, попытайтесь сбросить его каким-либо образом, подходящим для конкретного потока, например, переместив его в начальную точку. Не все потоки ввода символов поддерживают операцию reset(), и некоторые поддерживают reset() без поддержки mark().

Исключения:

IOException - Если поток не был помечен, или метка устарела, или поток не поддерживает reset(), или произошла другая ошибка ввода/вывода

close

public abstract void close()
                    throws IOException

Закрывает поток и освобождает все системные ресурсы, связанные с ним. После того, как поток закрыт, дальнейшие вызовы read(), ready(), mark(), reset() или skip() вызовут исключение IOException. Закрытие уже закрытого потока не оказывает никакого эффекта.

Задано:

close в интерфейсе Closeable

Задано:

close в интерфейсе AutoCloseable

Исключения:

IOException - Если произошла ошибка ввода/вывода