ProgressReporter.ProgressReport

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gudy.azureus2.ui.swt.progress
Class ProgressReporter.ProgressReport

java.lang.Object
  org.gudy.azureus2.ui.swt.progress.ProgressReporter.ProgressReport

All Implemented Interfaces:: IProgressReport

Enclosing class:: ProgressReporter

public class ProgressReporter.ProgressReport
extends Object
implements IProgressReport
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.

Author:: knguyen
See Also:: ProgressReporter.getProgressReport()

Field Summary
`boolean`	`isCanceled`

Method Summary
`String`	`getDetailMessage()` Returns the detail message for this particular report
`String`	`getErrorMessage()` Returns the error message (if any) for this report
`org.eclipse.swt.graphics.Image`	`getImage()` Returns the image of the reporter
`int`	`getMaximum()` Returns the maximum amount of work to be done
`String`	`getMessage()` Returns the message for this particular report
`int`	`getMinimum()` Returns the minimum amount of work to be done
`String`	`getName()` Returns the name of the reporter
`Object`	`getObjectData()` Returns the object associated with this report
`int`	`getPercentage()` Returns the percentage of work done so far
`IProgressReporter`	`getReporter()`
`int`	`getReporterID()` Returns the id of the reporter that created this report
`String`	`getReporterType()` Returns the reporter type of the reporter that created this report
`int`	`getReportType()` Returns the type of report this is
`int`	`getSelection()` Returns the amount of work done so far
`String`	`getTitle()` Returns the title of the reporter; this is mainly used as a window title if the reporter is shown by itself in a window
`boolean`	`isActive()` Returns whether the reporter is still in active state
`boolean`	`isCancelAllowed()` Returns whether the process owning the reporter allows a cancel request
`boolean`	`isCanceled()` Returns whether the reporter has been canceled
`boolean`	`isDisposed()` Returns whether the reporter has been marked for disposal
`boolean`	`isDone()` Returns whether the reporter is done with all its work
`boolean`	`isIndeterminate()` Returns whether the amount of work done so far can not be calculated accurately
`boolean`	`isInErrorState()` Returns whether the reporter has reported an error
`boolean`	`isPercentageInUse()` Returns whether the amount of work done is in percentage form
`boolean`	`isRetryAllowed()` Returns whether the process owning the reporter allows a retry request

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

isCanceled

public final boolean isCanceled

Method Detail

getReporter

public IProgressReporter getReporter()

Specified by:: getReporter in interface IProgressReport