Класс ProgressMonitorInputStream

javax.swing.ProgressMonitorInputStream

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

public class ProgressMonitorInputStream extends FilterInputStream

Отслеживает ход чтения из некоторого InputStream. Обычно этот ProgressMonitor вызывается примерно следующим образом:

InputStream in = new BufferedInputStream(
                         new ProgressMonitorInputStream(
                                 parentComponent,
                                 "Reading " + fileName,
                                 new FileInputStream(fileName)));

Создаёт монитор выполнения для отслеживания хода чтения входного потока. Если чтение занимает много времени, появляется ProgressDialog, информирующий пользователя. Если пользователь нажмёт кнопку «Отмена», при следующем чтении будет выброшено исключение InterruptedIOException. При закрытии потока выполняется вся необходимая очистка.

Дополнительную документацию и примеры см. в разделе Как отслеживать ход выполнения учебника Java.

Начиная с версии:

1.2

См. также:

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

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

in

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

Конструктор	Описание
`ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)`	Создаёт объект для отслеживания хода чтения входного потока.

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Переопределяет `FilterInputStream.close`, чтобы закрыть монитор выполнения вместе с потоком.
`ProgressMonitor`	`getProgressMonitor()`	Возвращает объект ProgressMonitor, используемый этим потоком.
`int`	`read()`	Переопределяет `FilterInputStream.read` для обновления монитора выполнения после чтения.
`int`	`read(byte[] b)`	Переопределяет `FilterInputStream.read` для обновления монитора выполнения после чтения.
`int`	`read(byte[] b, int off, int len)`	Переопределяет `FilterInputStream.read` для обновления монитора выполнения после чтения.
`void`	`reset()`	Переопределяет `FilterInputStream.reset`, чтобы сбросить монитор выполнения вместе с потоком.
`long`	`skip(long n)`	Переопределяет `FilterInputStream.skip` для обновления монитора выполнения после пропуска данных.

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

available, mark, markSupported

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

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

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

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

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

ProgressMonitorInputStream

public ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)

Создаёт объект для отслеживания хода чтения входного потока.

Параметры:: parentComponent — компонент, инициирующий отслеживаемую операцию.; message — описательный текст, который будет отображаться в диалоговом окне, если оно появится.; in — отслеживаемый входной поток.

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

getProgressMonitor

public ProgressMonitor getProgressMonitor()

Возвращает объект ProgressMonitor, используемый этим потоком. Обычно он не требуется, если только вы не хотите, например, изменить описательный текст в процессе чтения файла.

Возвращает:: объект ProgressMonitor, используемый этим объектом

read

public int read() throws IOException

Переопределяет FilterInputStream.read для обновления монитора выполнения после чтения.

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

read в классе FilterInputStream

Возвращает:

следующий байт данных или -1, если достигнут конец потока.

Выбрасывает:

IOException — при возникновении ошибки ввода-вывода.

См. также:

read

public int read(byte[] b) throws IOException

Переопределяет FilterInputStream.read для обновления монитора выполнения после чтения.

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

read в классе FilterInputStream

Параметры:

b — буфер, в который считываются данные.

Возвращает:

общее количество байтов, считанных в буфер, или -1, если данных больше нет, поскольку достигнут конец потока.

Выбрасывает:

IOException — при возникновении ошибки ввода-вывода.

См. также:

read

public int read(byte[] b, int off, int len) throws IOException

Переопределяет FilterInputStream.read для обновления монитора выполнения после чтения.

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

read в классе FilterInputStream

Параметры:

b — буфер, в который считываются данные.

off — начальное смещение в массиве b, по которому записываются данные.

len — максимальное количество байтов для чтения.

Возвращает:

общее количество байтов, считанных в буфер, или -1, если данных больше нет, поскольку достигнут конец потока.

Выбрасывает:

IOException — при возникновении ошибки ввода-вывода.

См. также:

skip

public long skip(long n) throws IOException

Переопределяет FilterInputStream.skip для обновления монитора выполнения после пропуска данных.

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

skip в классе FilterInputStream

Параметры:

n — количество байтов, которые нужно пропустить.

Возвращает:

фактическое количество пропущенных байтов.

Выбрасывает:

IOException — если in.skip(n) выбрасывает IOException.

См. также:

close

public void close() throws IOException

Переопределяет FilterInputStream.close, чтобы закрыть монитор выполнения вместе с потоком.

Определено в:

close в интерфейсе AutoCloseable

Определено в:

close в интерфейсе Closeable

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

close в классе FilterInputStream

Выбрасывает:

IOException — при возникновении ошибки ввода-вывода.

См. также:

reset

public void reset() throws IOException

Переопределяет FilterInputStream.reset, чтобы сбросить монитор выполнения вместе с потоком.

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

reset в классе FilterInputStream

Выбрасывает:

IOException — если для этого потока не была установлена метка или если метка стала недействительной.

См. также:

© 1993, 2025, 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/25/docs/api/java.desktop/javax/swing/ProgressMonitorInputStream.html