Package loci.common
Class StatusEvent
java.lang.Object
loci.common.StatusEvent
An event indicating a status update.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionStatusEvent(int progress, int maximum, String message) Constructs a non-warning status event.StatusEvent(int progress, int maximum, String message, boolean warn) Constructs a status event.StatusEvent(String message) Constructs a non-warning status event.StatusEvent(String message, boolean warn) Constructs a status event. -
Method Summary
-
Field Details
-
progress
protected int progressCurrent progress value. -
maximum
protected int maximumCurrent progress maximum. -
status
Current status message. -
warning
protected boolean warningWhether or not this is a warning event.
-
-
Constructor Details
-
StatusEvent
Constructs a non-warning status event. The initial progress and maximum progress are set to -1.- Parameters:
message- the initial status message
-
StatusEvent
Constructs a status event. The initial progress and maximum progress are set to -1.- Parameters:
message- the initial status messagewarn- true if this is a warning event
-
StatusEvent
Constructs a non-warning status event.- Parameters:
progress- the current progress valuemaximum- the maximum progress valuemessage- the initial status message
-
StatusEvent
Constructs a status event.- Parameters:
progress- the current progress valuemaximum- the maximum progress valuemessage- the initial status messagewarn- true if this is a warning event
-
-
Method Details
-
getProgressValue
public int getProgressValue()- Returns:
- the progress value. Returns -1 if progress is unknown.
-
getProgressMaximum
public int getProgressMaximum()- Returns:
- progress maximum. Returns -1 if progress is unknown.
-
getStatusMessage
- Returns:
- status message.
-
isWarning
public boolean isWarning()- Returns:
- true if this is a warning event.
-
toString
-