Класс LineNumberReader

java.lang.Object

java.io.Reader

java.io.BufferedReader

java.io.LineNumberReader

Все реализованные интерфейсы:: Closeable, AutoCloseable, Readable

public class LineNumberReader extends BufferedReader

Буферизованный символьный поток ввода, который отслеживает номера строк. Этот класс определяет методы setLineNumber(int) и getLineNumber() для установки и получения текущего номера строки соответственно.

По умолчанию нумерация строк начинается с 0. Это число увеличивается при каждом терминаторе строки при чтении данных, и в конце потока, если последний символ в потоке не является терминатором строки. Это число может быть изменено с помощью вызова setLineNumber(int). Обратите внимание, однако, что setLineNumber(int) фактически не изменяет текущую позицию в потоке; он только изменяет значение, которое будет возвращено методом getLineNumber().

Строка считается законченной любым из следующих символов: перевод строки ('\n'), возврат каретки ('\r'), возврат каретки, за которым сразу следует перевод строки, или любым из предыдущих терминаторов, за которыми следует конец потока, или конец потока, не предшествующий другим терминаторам.

С момента:: 1.1

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

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

lock

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

Конструктор	Описание
`LineNumberReader(Reader in)`	Создает новый читатель номеров строк, используя размер буфера по умолчанию.
`LineNumberReader(Reader in, int sz)`	Создает новый читатель номеров строк, читающий символы в буфер заданного размера.

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

Модификатор и тип	Метод	Описание
`int`	`getLineNumber()`	Получить текущий номер строки.
`void`	`mark(int readAheadLimit)`	Пометить текущую позицию в потоке.
`int`	`read()`	Прочитать один символ.
`int`	`read(char[] cbuf, int off, int len)`	Считывает символы в часть массива.
`String`	`readLine()`	Прочитать строку текста.
`void`	`reset()`	Сбросить поток до последней метки.
`void`	`setLineNumber(int lineNumber)`	Установить текущий номер строки.

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

close, lines, markSupported, ready

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

nullReader, read, read, skip, transferTo

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

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

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

LineNumberReader

public LineNumberReader(Reader in)

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

Параметры:: in - Объект Reader, предоставляющий базовый поток

LineNumberReader

public LineNumberReader(Reader in, int sz)

Создает новый читатель номеров строк, читающий символы в буфер заданного размера.

Параметры:: in - Объект Reader, предоставляющий базовый поток; sz - Целое число, определяющее размер буфера

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

setLineNumber

public void setLineNumber(int lineNumber)

Установить текущий номер строки.

Параметры:

lineNumber - Целое число, определяющее номер строки

См. также:

getLineNumber()

getLineNumber

public int getLineNumber()

Получить текущий номер строки.

Возвращает:

Текущий номер строки

См. также:

setLineNumber(int)

read

public int read() throws IOException

Прочитать один символ. Терминаторы строк сжимаются в один символ новой строки ('\n'). Текущий номер строки увеличивается всякий раз, когда считывается терминатор строки или когда достигается конец потока, и последний символ в потоке не является терминатором строки.

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

read

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

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

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

Терминаторы строк сжимаются в один символ новой строки ('\n'). Текущий номер строки увеличивается всякий раз, когда считывается терминатор строки или когда достигается конец потока, и последний символ в потоке не является терминатором строки.

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

readLine

public String readLine() throws IOException

Прочитать строку текста. Терминаторы строк сжимаются в один символ новой строки ('\n'). Текущий номер строки увеличивается всякий раз, когда считывается терминатор строки или когда достигается конец потока, и последний символ в потоке не является терминатором строки.

Переопределяет:

readLine в классе BufferedReader

Возвращает:

Строка, содержащая содержимое строки, не включая символы терминации строки, или null, если достигнут конец потока

Исключение:

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

См. также:

Files.readAllLines(java.nio.file.Path, java.nio.charset.Charset)

mark

public void mark(int readAheadLimit) throws IOException

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

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

reset

public void reset() throws IOException

Сбросить поток до последней метки.

Переопределяет:: reset в классе BufferedReader
Исключение:: IOException - Если поток не был помечен или метка была аннулирована

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