Package de.willuhn.util
Interface ProgressMonitor
-
- All Known Implementing Classes:
ConsoleProgessMonitor
public interface ProgressMonitor
Ein Interface, welches (implementiert) verwendet werden kann, wenn eine Funktion Ausgaben ueber den aktuellen Bearbeitungsstand ausgeben soll. Hierzu kann es beispielsweise eine Implementierung geben, welche die Ausgaben auf die Console schreibt oder in einem grafischen Dialog als Fortschrittsbalken zeigt.
-
-
Field Summary
Fields Modifier and Type Field Description static int
STATUS_CANCEL
Konstante fuer Status "Durch Benutzer abgebrochen".static int
STATUS_DONE
Konstante fuer Status "Erfolgreich beendet".static int
STATUS_ERROR
Konstante fuer Status "Mit Fehlern beendet".static java.util.Map<java.lang.Integer,java.lang.String>
STATUS_MAP
Map, die Status-Codes auf lesbaren Text mappt.static int
STATUS_NONE
Konstante fuer Status "noch kein Status gesetzt".static int
STATUS_RUNNING
Konstante fuer Status "Laeuft gerade".
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPercentComplete(int percent)
Teilt dem Monitor mit, wieviel Prozent der Aufgabe gerade erledigt wurde.int
getPercentComplete()
Liefert den aktuell angezeigten Fortschritt in Prozent.void
log(java.lang.String msg)
Teilt dem Monitor mit, dass der angegebene Text protokolliert werden soll.void
setPercentComplete(int percent)
Teilt dem Monitor mit, wieviel Prozent der Aufgabe bereits abgearbeitet sind.void
setStatus(int status)
Teilt dem Monitor den aktuellen Status mit.void
setStatusText(java.lang.String text)
Teilt dem Monitor einen sprechenden Status-Text mit.
-
-
-
Field Detail
-
STATUS_NONE
static final int STATUS_NONE
Konstante fuer Status "noch kein Status gesetzt".- See Also:
- Constant Field Values
-
STATUS_RUNNING
static final int STATUS_RUNNING
Konstante fuer Status "Laeuft gerade".- See Also:
- Constant Field Values
-
STATUS_ERROR
static final int STATUS_ERROR
Konstante fuer Status "Mit Fehlern beendet".- See Also:
- Constant Field Values
-
STATUS_DONE
static final int STATUS_DONE
Konstante fuer Status "Erfolgreich beendet".- See Also:
- Constant Field Values
-
STATUS_CANCEL
static final int STATUS_CANCEL
Konstante fuer Status "Durch Benutzer abgebrochen".- See Also:
- Constant Field Values
-
STATUS_MAP
static final java.util.Map<java.lang.Integer,java.lang.String> STATUS_MAP
Map, die Status-Codes auf lesbaren Text mappt.
-
-
Method Detail
-
setPercentComplete
void setPercentComplete(int percent)
Teilt dem Monitor mit, wieviel Prozent der Aufgabe bereits abgearbeitet sind. Bitte einen absoluten Wert angeben. Der Fortschritt wird dann unabhaengig vom vorherigen Wert auf den hier uebergebenen gesetzt.- Parameters:
percent
- prozentualer Fortschritt (muss zwischen 0 und 100 liegen).
-
addPercentComplete
void addPercentComplete(int percent)
Teilt dem Monitor mit, wieviel Prozent der Aufgabe gerade erledigt wurde. Bitte hier einen relativen positiven Wert angeben, um den der aktuelle Wert erhoeht werden soll.- Parameters:
percent
- Anzahl der Prozent-Punkte, um die der Fortschritt erhoeht werden soll.
-
getPercentComplete
int getPercentComplete()
Liefert den aktuell angezeigten Fortschritt in Prozent.- Returns:
- aktueller Fortschritt.
-
setStatus
void setStatus(int status)
Teilt dem Monitor den aktuellen Status mit.- Parameters:
status
- der aktuelle Status.- See Also:
STATUS_NONE
,STATUS_RUNNING
,STATUS_DONE
,STATUS_CANCEL
,STATUS_ERROR
-
setStatusText
void setStatusText(java.lang.String text)
Teilt dem Monitor einen sprechenden Status-Text mit.- Parameters:
text
- Status-Text.
-
log
void log(java.lang.String msg)
Teilt dem Monitor mit, dass der angegebene Text protokolliert werden soll.- Parameters:
msg
- die zur protokollierende Nachricht.
-
-