|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gudy.azureus2.ui.swt.progress.ProgressReporter.ProgressReport
public class ProgressReporter.ProgressReport
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.
ProgressReporter.getProgressReport()
Field Summary | |
---|---|
boolean |
isCanceled
|
Method Summary | |
---|---|
java.lang.String |
getDetailMessage()
Returns the detail message for this particular report |
java.lang.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 |
java.lang.String |
getMessage()
Returns the message for this particular report |
int |
getMinimum()
Returns the minimum amount of work to be done |
java.lang.String |
getName()
Returns the name of the reporter |
java.lang.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 |
java.lang.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 |
java.lang.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 |
---|
public final boolean isCanceled
Method Detail |
---|
public IProgressReporter getReporter()
getReporter
in interface IProgressReport
public java.lang.String getReporterType()
IProgressReport
getReporterType
in interface IProgressReport
public int getReporterID()
IProgressReport
getReporterID
in interface IProgressReport
public int getMinimum()
IProgressReport
getMinimum
in interface IProgressReport
public int getMaximum()
IProgressReport
getMaximum
in interface IProgressReport
public int getSelection()
IProgressReport
getSelection
in interface IProgressReport
public int getPercentage()
IProgressReport
getPercentage
in interface IProgressReport
public boolean isActive()
IProgressReport
isActive
in interface IProgressReport
public boolean isIndeterminate()
IProgressReport
isIndeterminate
in interface IProgressReport
public boolean isDone()
IProgressReport
isDone
in interface IProgressReport
public boolean isPercentageInUse()
IProgressReport
isPercentageInUse
in interface IProgressReport
public boolean isCancelAllowed()
IProgressReport
isCancelAllowed
in interface IProgressReport
public boolean isCanceled()
IProgressReport
isCanceled
in interface IProgressReport
public boolean isRetryAllowed()
IProgressReport
isRetryAllowed
in interface IProgressReport
public boolean isInErrorState()
IProgressReport
isInErrorState
in interface IProgressReport
public boolean isDisposed()
IProgressReport
isDisposed
in interface IProgressReport
public java.lang.String getTitle()
IProgressReport
getTitle
in interface IProgressReport
public java.lang.String getMessage()
IProgressReport
getMessage
in interface IProgressReport
public java.lang.String getDetailMessage()
IProgressReport
getDetailMessage
in interface IProgressReport
public java.lang.String getErrorMessage()
IProgressReport
getErrorMessage
in interface IProgressReport
public java.lang.String getName()
IProgressReport
getName
in interface IProgressReport
public org.eclipse.swt.graphics.Image getImage()
IProgressReport
getImage
in interface IProgressReport
public java.lang.Object getObjectData()
IProgressReport
getObjectData
in interface IProgressReport
public int getReportType()
IProgressReport
getReportType
in interface IProgressReport
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |