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
FieldsModifier and TypeFieldDescriptionstatic final int
Konstante fuer Status "Durch Benutzer abgebrochen".static final int
Konstante fuer Status "Erfolgreich beendet".static final int
Konstante fuer Status "Mit Fehlern beendet".Map, die Status-Codes auf lesbaren Text mappt.static final int
Konstante fuer Status "noch kein Status gesetzt".static final int
Konstante fuer Status "Laeuft gerade". -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPercentComplete
(int percent) Teilt dem Monitor mit, wieviel Prozent der Aufgabe gerade erledigt wurde.int
Liefert den aktuell angezeigten Fortschritt in Prozent.void
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
(String text) Teilt dem Monitor einen sprechenden Status-Text mit.
-
Field Details
-
STATUS_NONE
static final int STATUS_NONEKonstante fuer Status "noch kein Status gesetzt".- See Also:
-
STATUS_RUNNING
static final int STATUS_RUNNINGKonstante fuer Status "Laeuft gerade".- See Also:
-
STATUS_ERROR
static final int STATUS_ERRORKonstante fuer Status "Mit Fehlern beendet".- See Also:
-
STATUS_DONE
static final int STATUS_DONEKonstante fuer Status "Erfolgreich beendet".- See Also:
-
STATUS_CANCEL
static final int STATUS_CANCELKonstante fuer Status "Durch Benutzer abgebrochen".- See Also:
-
STATUS_MAP
Map, die Status-Codes auf lesbaren Text mappt.
-
-
Method Details
-
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:
-
setStatusText
Teilt dem Monitor einen sprechenden Status-Text mit.- Parameters:
text
- Status-Text.
-
log
Teilt dem Monitor mit, dass der angegebene Text protokolliert werden soll.- Parameters:
msg
- die zur protokollierende Nachricht.
-