Spec-Zone.ru › OpenJDK 8

Класс StringReader

  • java.lang.Object
    • java.io.Reader
      • java.io.StringReader
Все реализованные интерфейсы:
Closeable, AutoCloseable, Readable

public class StringReader
extends Reader

Поток символов, источником которого является строка.

С момента:
JDK1.1

Поля

Поля, унаследованные от класса java.io.Reader

lock

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

Конструктор и описание
StringReader(String s)

Создаёт новый читатель строк.

Методы

Модификатор и тип Метод и описание
void close()

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

void mark(int readAheadLimit)

Помечает текущую позицию в потоке.

boolean markSupported()

Указывает, поддерживает ли этот поток операцию mark(), которую он поддерживает.

int read()

Читает один символ.

int read(char[] cbuf, int off, int len)

Читает символы в часть массива.

boolean ready()

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

void reset()

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

long skip(long ns)

Пропускает указанное количество символов в потоке.

Методы, унаследованные от класса java.io.Reader

read, read

Методы, унаследованные от класса java.lang.Object

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

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

StringReader

public StringReader(String s)

Создаёт новый читатель строк.

Параметры:
s - Строка, предоставляющая поток символов.

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

read

public int read()
         throws IOException

Читает один символ.

Переопределяет:
read в классе Reader
Возвращает:
Прочитанный символ или -1, если достигнут конец потока
Исключения:
IOException - Если произошла ошибка ввода/вывода

read

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

Читает символы в часть массива.

Определено в:
read в классе Reader
Параметры:
cbuf - Буфер назначения
off - Смещение для начала записи символов
len - Максимальное количество символов для чтения
Возвращает:
Количество прочитанных символов или -1, если достигнут конец потока
Исключения:
IOException - Если произошла ошибка ввода/вывода

skip

public long skip(long ns)
          throws IOException

Пропускает указанное количество символов в потоке. Возвращает количество пропущенных символов.

Параметр ns может быть отрицательным, несмотря на то, что метод skip суперкласса Reader выбрасывает исключение в этом случае. Отрицательные значения ns приводят к пропусканию символов назад. Отрицательные значения возвращаемого значения указывают на пропуск назад. Пропуск назад за начало строки невозможен.

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

Переопределяет:
skip в классе Reader
Параметры:
ns - Количество символов для пропуска
Возвращает:
Количество фактически пропущенных символов
Исключения:
IOException - Если произошла ошибка ввода/вывода

ready

public boolean ready()
              throws IOException

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

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

markSupported

public boolean markSupported()

Указывает, поддерживает ли этот поток операцию mark(), которую он поддерживает.

Переопределяет:
markSupported в классе Reader
Возвращает:
true, если и только если этот поток поддерживает операцию mark.

mark

public void mark(int readAheadLimit)
          throws IOException

Помечает текущую позицию в потоке. Последующие вызовы reset() вернут поток в эту точку.

Переопределяет:
mark в классе Reader
Параметры:
readAheadLimit - Ограничение на количество символов, которые могут быть прочитаны, сохраняя при этом метку. Так как вход в поток происходит из строки, фактического ограничения нет, поэтому этот аргумент не должен быть отрицательным, но в противном случае игнорируется.
Исключения:
IllegalArgumentException - Если readAheadLimit < 0
IOException - Если произошла ошибка ввода/вывода

reset

public void reset()
           throws IOException

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

Переопределяет:
reset в классе Reader
Исключения:
IOException - Если произошла ошибка ввода/вывода

close

public void close()

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

Определено в:
close в интерфейсе Closeable
Определено в:
close в интерфейсе AutoCloseable
Определено в:
close в классе Reader

© 1993, 2020, 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.

Spec-Zone.ru

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