Класс ProgressMonitorInputStream

public class ProgressMonitorInputStream
extends FilterInputStream

Отслеживает процесс чтения из некоторого потока InputStream. Этот ProgressMonitor обычно вызывается примерно в таком виде:

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

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

Для получения дополнительной документации и примеров см. Как отслеживать прогресс, раздел в Руководстве по Java.

Детали конструкторов

ProgressMonitorInputStream

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

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

Параметры:

message - Описательный текст, который будет помещен в диалоговое окно, если оно будет отображено.

parentComponent - Компонент, инициирующий отслеживаемую операцию.

in - Поток ввода, который необходимо отслеживать.

Детали методов

getProgressMonitor

public ProgressMonitor getProgressMonitor()

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

Возвращает:

объект ProgressMonitor, используемый этим объектом

read

public int read()
         throws IOException

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

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

read в классе FilterInputStream

Возвращает:

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

Исключение:

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

См. также:

FilterInputStream.in

read

public int read(byte[] b)
         throws IOException

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

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

read в классе FilterInputStream

Параметры:

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

Возвращает:

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

Исключение:

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

См. также:

FilterInputStream.read(byte[], int, int)

read

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

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

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

read в классе FilterInputStream

Параметры:

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

off - начальный смещение в целевом массиве b

len - максимальное количество считываемых байтов.

Возвращает:

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

Исключение:

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

См. также:

FilterInputStream.in

skip

public long skip(long n)
          throws IOException

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

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

skip в классе FilterInputStream

Параметры:

n - количество байтов для пропуска.

Возвращает:

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

Исключение:

IOException - если поток не поддерживает поиск или произошла другая ошибка ввода-вывода.

close

public void close()
           throws IOException

Переопределяет FilterInputStream.close для закрытия монитора прогресса и потока.

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

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

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

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

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

close в классе FilterInputStream

Исключение:

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

См. также:

FilterInputStream.in

reset

public void reset()
           throws IOException

Переопределяет FilterInputStream.reset для сброса монитора прогресса и потока.

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

reset в классе FilterInputStream

Исключение:

IOException - если поток не был помечен или метка была аннулирована.

См. также:

FilterInputStream.in, FilterInputStream.mark(int)