Spec-Zone.ru › OpenJDK 17

Класс StringReader

java.lang.Object
java.io.Reader
java.io.StringReader
Все реализованные интерфейсы:
Closeable, AutoCloseable, Readable
public class StringReader extends Reader
Поток символов, чьим источником является строка.
С момента:
1.1

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

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

lock

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

Конструктор Описание
StringReader(String s)
Создает новый объект StringReader.

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

Модификатор и тип Метод Описание
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 n)
Пропускает символы.

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

nullReader, read, read, transferTo

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

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

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

StringReader

public StringReader(String s)
Создает новый объект StringReader.
Параметры:
s - Строка, предоставляющая поток символов.

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

read

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

read

public int read(char[] cbuf, int off, int len) throws IOException
Читает символы в часть массива.

Если len равно нулю, то символы не читаются и возвращается 0; в противном случае, происходит попытка прочитать хотя бы один символ. Если ни один символ недоступен, потому что поток достиг конца, возвращается значение -1; в противном случае, по крайней мере один символ читается и сохраняется в cbuf.

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

skip

public long skip(long n) throws IOException
Пропускает символы. Если поток уже достиг своего конца до вызова этого метода, то символы не пропускаются и возвращается ноль.

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

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

Переопределяет:
skip в классе Reader
Параметры:
n - Количество символов для пропуска
Возвращает:
Количество фактически пропущенных символов
Исключения:
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 в интерфейсе AutoCloseable
Определено:
close в интерфейсе Closeable
Определено:
close в классе Reader

© 1993, 2021, 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/17/docs/api/java.base/java/io/StringReader.html

Spec-Zone.ru

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