org.flexiblepower.api.efi.commonhelper

Class TimerModel

java.lang.Object

org.flexiblepower.efi.util.Timer

org.flexiblepower.api.efi.commonhelper.TimerModel

public class TimerModel
extends Timer

The implementation of the timer that can change when new updates are received and that provides information on whether the timer is blocking or finished.

Constructor Summary

Constructors

Constructor and Description
TimerModel(Timer base) Constructs a new timer.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getFinishedAt() Returns the finishedAt moment.
boolean	isBlockingAt(java.util.Date moment) Returns whether the timer is blocking at this moment.
void	updateFinishedAt(java.util.Date finishedAt) A new finishedAt moment overwrites the old moment.

Methods inherited from class org.flexiblepower.efi.util.Timer

equals, getDuration, getId, getLabel, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimerModel

public TimerModel(Timer base)

Constructs a new timer.

Parameters:

base - The object that holds the information from the EFI message about the Timer.

Method Detail

updateFinishedAt

public void updateFinishedAt(java.util.Date finishedAt)

A new finishedAt moment overwrites the old moment.

Parameters:

finishedAt - The new date at which the timer should be finished.

getFinishedAt

public java.util.Date getFinishedAt()

Returns the finishedAt moment.

Returns:

The moment at which the timer is finished.

isBlockingAt

public boolean isBlockingAt(java.util.Date moment)

Returns whether the timer is blocking at this moment. No finishedAt time implies that this timer is not blocking.

Parameters:

moment - The timestamp for which we should check.

Returns:

A boolean indicating whether the timer is blocking or not at the given moment.