Class ProgressReporter.ProgressReport

java.lang.Object
com.biglybt.ui.swt.progress.ProgressReporter.ProgressReport
All Implemented Interfaces:
IProgressReport
Enclosing class:
ProgressReporter
public class ProgressReporter.ProgressReport extends Object implements IProgressReport
An immutable object containing all interesting values in a ProgressReporter.

This represents a snapshot of all values at a single moment so instantiation of this class should be guarded against multi-threaded modification of the source ProgressReporter

This class is the only way an observer can query the properties of a ProgressReporter; though they do not have to be, all variables are declared final to help remind the user of this class that modification to any of its properties would have no effect on the reporter itself.

An exception to this insulation is the objectData variable; both the reporter and the ProgressReport consumer have full access to it. This is to facilitate advanced 2-way communication between the 2 parties.

See Also:

  • Field Details

    • reporterType

      private final String reporterType

    • reporterID

      private final int reporterID

    • minimum

      private final int minimum

    • maximum

      private final int maximum

    • selection

      private final int selection

    • percentage

      private final int percentage

    • isActive

      private final boolean isActive

    • isIndeterminate

      private final boolean isIndeterminate

    • isDone

      private final boolean isDone

    • isPercentageInUse

      private final boolean isPercentageInUse

    • isCancelAllowed

      private final boolean isCancelAllowed

    • isCanceled

      public final boolean isCanceled

    • isRetryAllowed

      private final boolean isRetryAllowed

    • isInErrorState

      private final boolean isInErrorState

    • isDisposed

      private final boolean isDisposed

    • title

      private final String title

    • message

      private final String message

    • detailMessage

      private final String detailMessage

    • errorMessage

      private final String errorMessage

    • name

      private final String name

    • image

      private final org.eclipse.swt.graphics.Image image

    • objectData

      private final Object objectData

    • REPORT_TYPE

      private final int REPORT_TYPE

  • Constructor Details

    • ProgressReport

      private ProgressReport()
      Construct a ProgressReport

  • Method Details