com.yashovardhan99.timeit

Class Timer

java.lang.Object

com.yashovardhan99.timeit.Timer

public class Timer
extends Object

The timer class is a utility class for creating and managing count down timers in android. This class provides basic features like : start, stop, pause and resume. You must set a duration to use the timer. This duration must be a positive long integer for the timer to work. You can also set a textView to auto-update every 0.1 second or use the OnTickListener interface to listen for clock update events. Created by Yashovardhan99 on 24/12/18 as a part of TimeIt.

Since:

1.2

Version:

1.2

Author:

Yashovardhan Dhanania

See Also:

Stopwatch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Timer.OnTickListener Listener interface to listen for important clock events with the timer.

Constructor Summary

Constructors

Constructor and Description
Timer() The default constructor used to create an instance of Timer.
Timer(long duration) Parameterized constructor used to initialize an instance of Timer with a specified duration

Method Summary

Modifier and Type	Method and Description
long	getDuration() Fetch the set duration of the timer
long	getRemainingTime() Get the remaining time of the timer in milliseconds
long	getStart() Get the start time in long
boolean	isPaused() Returns true if the timer is paused
boolean	isStarted() Returns true if the timer has been started
void	pause() Used to pause the timer.
void	resume() Used to resume a paused timer.
void	setDuration(long duration) Used to set the duration of the timer.
void	setOnTickListener(Timer.OnTickListener onTickListener) Used to set an OnTickListener to listen to clock events
void	setTextView(TextView textView) Used to set the textView which is auto-updated every clock tick.
void	start() Used to start the timer.
void	stop() Used to stop the timer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Timer

public Timer()

The default constructor used to create an instance of Timer. Duration is set to a default value of 0 which should be changed before calling start.

Since:

1.2

See Also:

Timer(long), setDuration(long)

Timer

public Timer(long duration)

Parameterized constructor used to initialize an instance of Timer with a specified duration

Parameters:

duration - the duration for which the timer should run in milliseconds

Since:

1.2

See Also:

Timer()

Method Detail

isStarted

public boolean isStarted()

Returns true if the timer has been started

Returns:

true if the timer has been started

Since:

1.2

isPaused

public boolean isPaused()

Returns true if the timer is paused

Returns:

true if the timer is paused

Since:

1.2

getRemainingTime

public long getRemainingTime()

Get the remaining time of the timer in milliseconds

Returns:

the remaining time of the timer in milliseconds

Since:

1.2

getStart

public long getStart()

Get the start time in long

Returns:

the timestamp when the timer was started

Since:

1.2

getDuration

public long getDuration()

Fetch the set duration of the timer

Returns:

the set duration of the timer in milliseconds

Since:

1.2

setDuration

public void setDuration(long duration)

Used to set the duration of the timer. Note : Should only be used once before starting the timer or it may have unintended consequences.

Parameters:

duration - the duration in milliseconds for which you want to set the timer

Since:

1.2

setTextView

public void setTextView(@Nullable
                        TextView textView)

Used to set the textView which is auto-updated every clock tick.

Parameters:

textView - the textView to update every clock tick.

Since:

1.2

setOnTickListener

public void setOnTickListener(Timer.OnTickListener onTickListener)

Used to set an OnTickListener to listen to clock events

Parameters:

onTickListener - an instance of Timer.OnTickListener

Since:

1.2

See Also:

Timer.OnTickListener

start

public void start()

Used to start the timer. Should only be called if the timer is not already started.

Since:

1.2

stop

public void stop()

Used to stop the timer. Should only be called if the timer is already started.

Since:

1.2

pause

public void pause()

Used to pause the timer. Should only be called if the timer is currently running

Since:

1.2

resume

public void resume()

Used to resume a paused timer. Should only be used after a pause call.

Since:

1.2