Package de.bsvrz.sys.funclib.timeout
Class TimeoutTimer
- java.lang.Object
-
- de.bsvrz.sys.funclib.timeout.TimeoutTimer
-
public class TimeoutTimer extends java.lang.Object
Ein Objekt dieser Klasse kann mit einer Uhrzeit oder einer Zeitspanne initialisert werden. Das Objekt stellt eine MethodeisTimeExpired()
zur Verfügung, mit der Angefragt werden kann, ob die Uhrzeit erreicht wurde oder ob die Zeitspanne abgelaufen ist.
-
-
Constructor Summary
Constructors Constructor Description TimeoutTimer(long time)
Ein Objekt, das mit einer Zeitspanne initialisiert wird.TimeoutTimer(java.util.Date date)
Ein Objekt, das mit einem Zeitpunkt initialisiert wird.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
getRemainingTime()
Diese Methode liefert die verbleibende Zeit, bis die vorgegebene Zeitspanne/Zeitpunkt abgelaufen ist.boolean
isTimeExpired()
Diese Methode wird aufgerufen, wenn geprüft werden soll ob die festgelegte Zeitspanne abgelaufen ist oder der festgelegte Zeitpunkt erreicht wurde.java.lang.String
toString()
-
-
-
Constructor Detail
-
TimeoutTimer
public TimeoutTimer(long time)
Ein Objekt, das mit einer Zeitspanne initialisiert wird. Ist die geforderte Zeitspanne abgelaufen, wird der MethodenaufrufisTimeExpired()
false
zurückliefern. Die Zeit wird ab dem Zeitpunkt gemessen, ab dem der Construktor aufgerufen wird.- Parameters:
time
- Zeitspanne, die ablaufen muss, bisisTimeExpired()
den Rückgabewertfalse
liefert
-
TimeoutTimer
public TimeoutTimer(java.util.Date date)
Ein Objekt, das mit einem Zeitpunkt initialisiert wird. Wird der geforderte Zeitpunkt überschritten, wird der MethodenaufrufisTimeExpired()
false
zurückliefern. Die Zeit wird ab dem Zeitpunkt gemessen, ab dem der Construktor aufgerufen wird.- Parameters:
date
- Zeitpunkt, der überschritten werden muss, damit die MethodeisTimeExpired()
false
zurückliefert
-
-
Method Detail
-
isTimeExpired
public boolean isTimeExpired()
Diese Methode wird aufgerufen, wenn geprüft werden soll ob die festgelegte Zeitspanne abgelaufen ist oder der festgelegte Zeitpunkt erreicht wurde.- Returns:
- true = die Zeit ist abgelaufen; false = die/der Zeitspanne/Zeitpunkt wurde noch nicht erreicht
-
getRemainingTime
public long getRemainingTime()
Diese Methode liefert die verbleibende Zeit, bis die vorgegebene Zeitspanne/Zeitpunkt abgelaufen ist.- Returns:
- Zeit, die noch verbleibt, bis der vorgegebene Wert erreicht wird (in ms). Ist die Zeit abgelaufen, wird immer
0
zurückgegeben.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-