Класс 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

public int getLineNumber()

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

Возвращает:

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

См. также:

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 - Если произошла ошибка ввода-вывода

См. также:

mark

public void mark(int readAheadLimit) throws IOException

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

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

reset

public void reset() throws IOException

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

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

© 1993, 2023, 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/21/docs/api/java.base/java/io/LineNumberReader.html