Spec-Zone.ru › OpenJDK 21

Класс LineNumberInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
java.io.LineNumberInputStream
Все реализованные интерфейсы:
Closeable, AutoCloseable
@Deprecated public class LineNumberInputStream extends FilterInputStream
Устарело.
Этот класс неправильно предполагает, что байты адекватно представляют символы. Начиная с JDK 1.1, предпочтительным способом работы с потоками символов являются новые классы потоков символов, которые включают класс для подсчёта номеров строк.
Этот класс — фильтр входного потока, который предоставляет дополнительную функциональность отслеживания текущего номера строки.

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

Номер строки начинается с 0, и увеличивается на 1 при каждом, когда метод read возвращает символ новой строки.

C момента:
1.0
См. также:
  • LineNumberReader

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

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

in

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

Конструктор Описание
LineNumberInputStream(InputStream in)
Устарело.
Создаёт входной поток с номером строки, который читает вход из указанного входного потока.

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

Модификатор и тип Метод Описание
int available()
Устарело.
Возвращает число байтов, которые могут быть прочитаны из этого входного потока без блокировки.
int getLineNumber()
Устарело.
Возвращает текущий номер строки.
void mark(int readlimit)
Устарело.
Помечает текущее положение в этом входном потоке.
int read()
Устарело.
Читает следующий байт данных из этого входного потока.
int read(byte[] b, int off, int len)
Устарело.
Читает до len байтов данных из этого входного потока в массив байтов.
void reset()
Устарело.
Перемещает этот поток в положение на момент последнего вызова метода mark для этого входного потока.
void setLineNumber(int lineNumber)
Устарело.
Устанавливает номер строки в указанное значение.
long skip(long n)
Устарело.
Пропускает и игнорирует n байтов данных из этого входного потока.

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

close, markSupported, read

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

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

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

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

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

LineNumberInputStream

public LineNumberInputStream(InputStream in)
Устарело.
Создаёт поток ввода с номерами строк, который считывает данные из указанного потока ввода.
Параметры:
in - базовый поток ввода.

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

read

public int read() throws IOException
Устарело.
Считывает следующий байт данных из этого потока ввода. Значение байта возвращается как целое число в диапазоне 0 до 255. Если байт недоступен из-за достижения конца потока, возвращается значение -1. Этот метод блокируется до тех пор, пока данные ввода не станут доступны, не будет обнаружен конец потока или не будет брошено исключение.

Метод read класса LineNumberInputStream вызывает метод read базового потока ввода. Он проверяет наличие символов возврата каретки и символов новой строки во входных данных и соответственно изменяет текущий номер строки. Символ возврата каретки или символ возврата каретки, за которым следует символ новой строки, оба преобразуются в один символ новой строки.

Переопределяет:
read в классе FilterInputStream
Возвращает:
следующий байт данных или -1 в случае достижения конца потока.
Исключения:
IOException - если произошла ошибка ввода-вывода.
См. также:
  • FilterInputStream.in
  • getLineNumber()

read

public int read(byte[] b, int off, int len) throws IOException
Устарело.
Считывает до len байтов данных из этого потока ввода в массив байтов. Этот метод блокируется до тех пор, пока некоторые данные ввода не станут доступны.

Метод read класса LineNumberInputStream повторно вызывает метод read без аргументов, чтобы заполнить массив байтов.

Переопределяет:
read в классе FilterInputStream
Параметры:
b - буфер, в который считываются данные.
off - начальный смещение данных.
len - максимальное количество считанных байтов.
Возвращает:
общее количество байтов, считанных в буфер, или -1 если больше нет данных из-за достижения конца потока.
Исключения:
IOException - если произошла ошибка ввода-вывода.
См. также:
  • read()

skip

public long skip(long n) throws IOException
Устарело.
Пропускает и отбрасывает n байтов данных из этого потока ввода. Метод skip может по разным причинам пропустить меньшее количество байтов, возможно, 0. Возвращается фактическое количество пропущенных байтов. Если n отрицательно, байты не пропускаются.

Метод skip класса LineNumberInputStream создаёт массив байтов и затем многократно считывает данные в него, пока не будет прочитано n байтов или не будет достигнут конец потока.

Переопределяет:
skip в классе FilterInputStream
Параметры:
n - количество байтов для пропуска.
Возвращает:
фактическое количество пропущенных байтов.
Исключения:
IOException - если произошла ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

setLineNumber

public void setLineNumber(int lineNumber)
Устарело.
Устанавливает номер строки в указанное значение.
Параметры:
lineNumber - новый номер строки.
См. также:
  • getLineNumber()

getLineNumber

public int getLineNumber()
Устарело.
Возвращает текущий номер строки.
Возвращает:
текущий номер строки.
См. также:
  • setLineNumber(int)

available

public int available() throws IOException
Устарело.
Возвращает количество байтов, которые можно прочитать из этого потока ввода без блокировки.

Обратите внимание, что если базовый поток ввода может предоставить k входных символов без блокировки, поток LineNumberInputStream может гарантировать предоставление только k/2 символов без блокировки, потому что k символов из базового потока ввода могут состоять из k/2 пар '\r' и '\n', которые преобразуются всего в k/2 '\n' символов.

Переопределяет:
available в классе FilterInputStream
Возвращает:
количество байтов, которые можно прочитать из этого потока ввода без блокировки.
Исключения:
IOException - если произошла ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

mark

public void mark(int readlimit)
Устарело.
Помечает текущую позицию в этом потоке ввода. Последующее вызов метода reset переместит этот поток в последнюю помеченную позицию, так что последующие чтения повторно прочитают те же байты.

Метод mark класса LineNumberInputStream запоминает текущий номер строки в личной переменной, а затем вызывает метод mark базового потока ввода.

Переопределяет:
mark в классе FilterInputStream
Параметры:
readlimit - максимальный предел байтов, которые можно прочитать, прежде чем позиция метки станет недействительной.
См. также:
  • FilterInputStream.in
  • reset()

reset

public void reset() throws IOException
Устарело.
Возвращает этот поток в позицию на момент последнего вызова метода mark для этого потока ввода.

Метод reset класса LineNumberInputStream сбрасывает номер строки на номер строки на момент вызова метода mark, а затем вызывает метод reset базового потока ввода.

Метки потоков предназначены для использования в ситуациях, когда вам нужно немного прочитать вперёд, чтобы увидеть, что находится в потоке. Часто это проще всего сделать, вызвав какой-либо общий анализатор. Если поток обрабатывается анализатором, он будет работать без проблем. Если поток не обрабатывается этим типом анализатора, анализатор должен бросить исключение при ошибке, которое, если это произойдёт в пределах readlimit байтов, позволяет внешнему коду сбросить поток и попробовать другой анализатор.

Переопределяет:
reset в классе FilterInputStream
Исключения:
IOException - если произошла ошибка ввода-вывода.
См. также:
  • FilterInputStream.in
  • mark(int)

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

Spec-Zone.ru

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