loci.common

Class StatusEvent

java.lang.Object

loci.common.StatusEvent

public class StatusEvent
extends Object

An event indicating a status update.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maximum Current progress maximum.
protected int	progress Current progress value.
protected String	status Current status message.
protected boolean	warning Whether or not this is a warning event.

Constructor Summary

Constructors

Constructor and Description
StatusEvent(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

Modifier and Type	Method and Description
int	getProgressMaximum()
int	getProgressValue()
String	getStatusMessage()
boolean	isWarning()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

progress

protected int progress

Current progress value.

maximum

protected int maximum

Current progress maximum.

status

protected String status

Current status message.

warning

protected boolean warning

Whether or not this is a warning event.

Constructor Detail

StatusEvent

public StatusEvent(String message)

Constructs a non-warning status event. The initial progress and maximum progress are set to -1.

Parameters:

message - the initial status message

StatusEvent

public StatusEvent(String message,
                   boolean warn)

Constructs a status event. The initial progress and maximum progress are set to -1.

Parameters:

message - the initial status message

warn - true if this is a warning event

StatusEvent

public StatusEvent(int progress,
                   int maximum,
                   String message)

Constructs a non-warning status event.

Parameters:

progress - the current progress value

maximum - the maximum progress value

message - the initial status message

StatusEvent

public StatusEvent(int progress,
                   int maximum,
                   String message,
                   boolean warn)

Constructs a status event.

Parameters:

progress - the current progress value

maximum - the maximum progress value

message - the initial status message

warn - true if this is a warning event

Method Detail

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

public String getStatusMessage()

Returns:

status message.

isWarning

public boolean isWarning()

Returns:

true if this is a warning event.

toString

public String toString()

Overrides:

toString in class Object