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 status event.
StatusEvent(int progress, int maximum, String message, boolean warn) Constructs a status event.
StatusEvent(String message) Constructs a status event.
StatusEvent(String message, boolean warn) Constructs a status event.

Method Summary

Methods

Modifier and Type	Method and Description
int	getProgressMaximum() Gets progress maximum.
int	getProgressValue() Gets progress value.
String	getStatusMessage() Gets status message.
boolean	isWarning() Returns whether or not this is a warning event.
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 status event.

StatusEvent

public StatusEvent(String message,
           boolean warn)

Constructs a status event.

StatusEvent

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

Constructs a status event.

StatusEvent

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

Constructs a status event.

Method Detail

getProgressValue

public int getProgressValue()

Gets progress value. Returns -1 if progress is unknown.

getProgressMaximum

public int getProgressMaximum()

Gets progress maximum. Returns -1 if progress is unknown.

getStatusMessage

public String getStatusMessage()

Gets status message.

isWarning

public boolean isWarning()

Returns whether or not this is a warning event.

toString

public String toString()

Overrides:

toString in class Object