com.example.staysafe

Class SSTimer

java.lang.Object

com.example.staysafe.SSTimer

public class SSTimer
extends java.lang.Object

The SSTimer class functions as a utility to the StaySafe application to facilitate all time data. Furthermore, this class uses the Android CountDownTimer to make able the StaySafe application to perform actions after a certain amount of time has elapsed.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	canceled boolean indicating if the timer count down was canceled.
private CountDownTimer	cdt The Android CountDownTimer timer used in the SSTimer
private OnSSTimerListener	listener The saved class implementing the OnSSTimerListener
private SSTimer	me Current instance of the SSSTimer
private long	minTime The minimum time associated with the current instance of the SSTimer
private long	startTime time when setStartTime()

Constructor Summary

Constructors

Constructor and Description
SSTimer() Constructor that saves the current instance of the class

Method Summary

Modifier and Type	Method and Description
void	cancelCountDown() Stops the timer
void	countDownFrom(int sec) sets the amount the timer will run before calling the onTimerDone method set via the OnSSTimerListener interface.
int	getTimeElapsed() Called when the time elapsed is desired
boolean	hasMinimumTimeElapsed() Indicates weather or not the minimum time set by setMinimumTimePeriod(int) has been reached
void	setMinimumTimePeriod(int seconds) set the minimum elapsed time for this timer
void	setOnSSTimerListener(java.lang.Object o) sets the onTimerDone method to be performed on timer completion
void	setStartTime() Sets the starting time of the timer
void	startCountDown() Starts the timer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

canceled

boolean canceled

boolean indicating if the timer count down was canceled.

cdt

private CountDownTimer cdt

The Android CountDownTimer timer used in the SSTimer

listener

private OnSSTimerListener listener

The saved class implementing the OnSSTimerListener

me

private SSTimer me

Current instance of the SSSTimer

minTime

private long minTime

The minimum time associated with the current instance of the SSTimer

startTime

private long startTime

time when setStartTime()

Constructor Detail

SSTimer

public SSTimer()

Constructor that saves the current instance of the class

Method Detail

cancelCountDown

public void cancelCountDown()

Stops the timer

countDownFrom

public void countDownFrom(int sec)

sets the amount the timer will run before calling the onTimerDone method set via the OnSSTimerListener interface. startCountDown() must be called to initiate the timer.

getTimeElapsed

public int getTimeElapsed()

Called when the time elapsed is desired

Returns:

the elapsed time from when setStartTime() was called

hasMinimumTimeElapsed

public boolean hasMinimumTimeElapsed()

Indicates weather or not the minimum time set by setMinimumTimePeriod(int) has been reached

Returns:

true if minimum time has elapsed false if the minimum time has not been reached

setMinimumTimePeriod

public void setMinimumTimePeriod(int seconds)

set the minimum elapsed time for this timer

setOnSSTimerListener

public void setOnSSTimerListener(java.lang.Object o)

sets the onTimerDone method to be performed on timer completion

setStartTime

public void setStartTime()

Sets the starting time of the timer

startCountDown

public void startCountDown()

Starts the timer