com.devbrackets.android.exomedia.util

Class StopWatch

java.lang.Object

com.devbrackets.android.exomedia.util.StopWatch

public class StopWatch
extends java.lang.Object

A simple stopwatch to keep a correct and updated record of the running duration of processes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StopWatch.TickListener

Constructor Summary

Constructors

Constructor and Description
StopWatch()
StopWatch(boolean processOnStartingThread)
StopWatch(Handler handler)

Method Summary

Modifier and Type	Method and Description
int	getTickDelay() Retrieves the approximate duration between time updates.
long	getTime() Retrieves the current time for the stopwatch.
boolean	isRunning() Determines if the stopwatch is currently running
void	overrideCurrentTime(long time) Forcefully sets the current time for the stopwatch.
void	reset() Resets the current time for the stopWatch
void	setTickDelay(int milliSeconds) Sets the approximate duration between time updates.
void	setTickListener(StopWatch.TickListener listener) Sets the listener to be notified for each time update (tick)
void	start() Starts the stopwatch.
void	stop() Stops the stopwatch, capturing the ending time

Methods inherited from class java.lang.Object

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

Constructor Detail

StopWatch

public StopWatch()

StopWatch

public StopWatch(boolean processOnStartingThread)

Parameters:

processOnStartingThread - True if the repeating process should be handled on the same thread that created the Repeater

StopWatch

public StopWatch(Handler handler)

Parameters:

handler - The Handler to use for the repeating process

Method Detail

setTickDelay

public void setTickDelay(int milliSeconds)

Sets the approximate duration between time updates.

Parameters:

milliSeconds - The approximate duration between time updates [default: ]

getTickDelay

public int getTickDelay()

Retrieves the approximate duration between time updates.

Returns:

The approximate duration in milliseconds between time updates

start

public void start()

Starts the stopwatch. This will continue from where we last left off, if you need to start from 0 call reset() first.

stop

public void stop()

Stops the stopwatch, capturing the ending time

reset

public void reset()

Resets the current time for the stopWatch

overrideCurrentTime

public void overrideCurrentTime(long time)

Forcefully sets the current time for the stopwatch.

Parameters:

time - The new stopwatch time in milliseconds

isRunning

public boolean isRunning()

Determines if the stopwatch is currently running

Returns:

True if the stopwatch is currently running

getTime

public long getTime()

Retrieves the current time for the stopwatch. If the stopwatch is stopped then the ending time will be returned.

Returns:

The time in milliseconds

setTickListener

public void setTickListener(StopWatch.TickListener listener)

Sets the listener to be notified for each time update (tick)

Parameters:

listener - The listener or null