Package com.compomics.util.interfaces

Interface Monitorable

All Known Implementing Classes:
MonitorableFileInputStream, MonitorableInputStream
public interface Monitorable
This interface describes the behaviour for any Object whose progressing state can be monitored.
Author:
Lennart Martens

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaximum()
    This method reports on the total amount steps the task can take before completion.
    int
    monitorProgress()
    This method returns the progress of the task.

  • Method Details

    • getMaximum

      int getMaximum()
      This method reports on the total amount steps the task can take before completion.
      Returns:
      int with the total bytes that can be read from the InputStream.

    • monitorProgress

      int monitorProgress()
      This method returns the progress of the task.
      Returns:
      int with the progress.