com.yashovardhan99.timeit

Class Stopwatch

java.lang.Object

com.yashovardhan99.timeit.Stopwatch

public class Stopwatch
extends Object

The Stopwatch class is used for creating and using a simple stopwatch with basic features like : start, pause, resume and split. It allows you to send a TextView and automatically updates it every 0.1 seconds (or as set by you). You can also implement the custom OnTickListener to listen for time changes every time period. Threading on a separate thread is handled by the class itself. You just need to call appropriate methods to control the stopwatch.

Created by Yashovardhan99 on 8/12/18 as a part of TimeIt.

Version:

1.2

Author:

Yashovardhan Dhanania

See Also:

Runnable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Stopwatch.OnTickListener Interface to listen for stopwatch tick events every time clock is updated.

Constructor Summary

Constructors

Constructor and Description
Stopwatch() The default constructor should be called to create an object to call functions accordingly.

Method Summary

Modifier and Type	Method and Description
long	getClockDelay() Returns the currently set clock delay
long	getElapsedTime() Gets the current elapsed time the stopwatch has been running for in milliseconds
LinkedList<Split>	getSplits() Get a list of all splits that have been created.
long	getStart() Returns the clock time (in milliseconds) when the stopwatch was started
boolean	isPaused() Returns true if the stopwatch is paused
boolean	isStarted() Returns true if the stopwatch has started
void	pause() Pauses the stopwatch.
void	resume() Used to resume the stopwatch from the current time after being paused.
void	setClockDelay(long clockDelay) Set a custom clock delay to increase/decrease update frequency.
void	setDebugMode(boolean debugMode) Set whether to print debug logs or not.
void	setOnTickListener(Stopwatch.OnTickListener onTickListener) Set an OnTickListener to listen for clock changes.
void	setTextView(TextView textView) Allows you to set a textView where the stopwatch time is displayed.
void	split() Creates a new split/lap at the current time.
void	start() Starts the stopwatch at the current time.
void	stop() Stops the stopwatch.

Methods inherited from class java.lang.Object

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

Constructor Detail

Stopwatch

public Stopwatch()

The default constructor should be called to create an object to call functions accordingly.

Since:

1.0

Method Detail

isStarted

public boolean isStarted()

Returns true if the stopwatch has started

Returns:

true if the stopwatch has been started by calling start(). False otherwise

Since:

1.0

isPaused

public boolean isPaused()

Returns true if the stopwatch is paused

Returns:

true if the stopwatch is paused. False otherwise

Since:

1.0

getElapsedTime

public long getElapsedTime()

Gets the current elapsed time the stopwatch has been running for in milliseconds

Returns:

the time in milliseconds the stopwatch has been running for.

Since:

1.0

getStart

public long getStart()

Returns the clock time (in milliseconds) when the stopwatch was started

Returns:

time when the stopwatch was started in milliseconds.

Since:

1.0

getSplits

public LinkedList<Split> getSplits()

Get a list of all splits that have been created.

Returns:

all splits created with split method.

Since:

1.0

See Also:

Split

getClockDelay

public long getClockDelay()

Returns the currently set clock delay

Returns:

currently set clock delay in milliseconds (default: 100ms)

Since:

1.0

setClockDelay

public void setClockDelay(long clockDelay)

Set a custom clock delay to increase/decrease update frequency. Clock delay is the delay in between each successive clock update.

Parameters:

clockDelay - clock delay in milliseconds (default : 100ms)

Since:

1.0

See Also:

Thread.sleep(long)

setDebugMode

public void setDebugMode(boolean debugMode)

Set whether to print debug logs or not. If enabled, it will log each time the time is updated.

Parameters:

debugMode - desired debugging status

Since:

1.0

setTextView

public void setTextView(@Nullable
                        TextView textView)

Allows you to set a textView where the stopwatch time is displayed. If not provided, or set to null, you need to manually display the time.

Parameters:

textView - the textView where you want to display the stopwatch time. Can be null.

Since:

1.0

setOnTickListener

public void setOnTickListener(Stopwatch.OnTickListener onTickListener)

Set an OnTickListener to listen for clock changes.

Parameters:

onTickListener - a reference to the interface implementation.

Since:

1.0

start

public void start()

Starts the stopwatch at the current time. Cannot be called again without calling stop() first.

Throws:

IllegalStateException - if the stopwatch has already been started.

Since:

1.0

See Also:

stop(), isStarted()

stop

public void stop()

Stops the stopwatch. Stopwatch cannot be resumed from current time later.

Throws:

IllegalStateException - if stopwatch has not been started yet.

Since:

1.0

See Also:

start(), isStarted()

pause

public void pause()

Pauses the stopwatch. Using this allows you to resume the stopwatch from the current state.

Throws:

IllegalStateException - if stopwatch is already paused or not started yet.

Since:

1.0

See Also:

resume(), isPaused()

resume

public void resume()

Used to resume the stopwatch from the current time after being paused.

Throws:

IllegalStateException - if stopwatch is not paused or not started yet.

Since:

1.0

See Also:

pause(), isPaused()

split

public void split()

Creates a new split/lap at the current time. Can even be called when stopwatch is paused.

Throws:

IllegalStateException - if stopwatch is not started yet

Since:

1.0

See Also:

getSplits()