StopWatch (library API)

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

protected class StopWatch.TickRunnable

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StopWatch.TickListener`
`protected class`	`StopWatch.TickRunnable`

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`currentTime`
`protected static int`	`DEFAULT_TICK_DELAY`
`protected android.os.Handler`	`delayedHandler`
`protected static java.lang.String`	`HANDLER_THREAD_NAME`
`protected android.os.HandlerThread`	`handlerThread`
`protected boolean`	`isRunning`
`protected StopWatch.TickListener`	`listener`
`protected float`	`speedMultiplier`
`protected long`	`startTime`
`protected long`	`storedTime`
`protected int`	`tickDelay`
`protected StopWatch.TickRunnable`	`tickRunnable`
`protected boolean`	`useHandlerThread`

Constructor Summary

Constructors
Constructor and Description

StopWatch()

StopWatch(boolean processOnStartingThread)

StopWatch(android.os.Handler handler)

Constructors
Constructor and Description
`StopWatch()`
`StopWatch(boolean processOnStartingThread)`
`StopWatch(android.os.Handler handler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getSpeedMultiplier()` Retrieves the current multiplier used for the current time calculations.
`int`	`getTickDelay()` Retrieves the approximate duration between time updates.
`long`	`getTime()` Retrieves the current time for the stopwatch.
`int`	`getTimeInt()` 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`	`setSpeedMultiplier(float multiplier)` Sets the multiplier to use when calculating the passed duration.
`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

- Field Detail
  - HANDLER_THREAD_NAME
```
protected static final java.lang.String HANDLER_THREAD_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TICK_DELAY
```
protected static final int DEFAULT_TICK_DELAY
```
    See Also:
    
    Constant Field Values
  - isRunning
```
protected volatile boolean isRunning
```
  - tickDelay
```
protected int tickDelay
```
  - delayedHandler
```
protected android.os.Handler delayedHandler
```
  - handlerThread
```
protected android.os.HandlerThread handlerThread
```
  - useHandlerThread
```
protected boolean useHandlerThread
```
  - listener
```
protected StopWatch.TickListener listener
```
  - tickRunnable
```
protected StopWatch.TickRunnable tickRunnable
```
  - startTime
```
protected long startTime
```
  - currentTime
```
protected long currentTime
```
  - storedTime
```
protected long storedTime
```
  - speedMultiplier
```
protected float speedMultiplier
```
- 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(android.os.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: 33]
  - getTickDelay
```
public int getTickDelay()
```
    Retrieves the approximate duration between time updates.
    
    Returns:
    
    The approximate duration in milliseconds between time updates
  - setSpeedMultiplier
```
public void setSpeedMultiplier(float multiplier)
```
    Sets the multiplier to use when calculating the passed duration. This won't affect the tick delay setTickDelay(int) but will change the output for the current time.
    
    Parameters:
    
    multiplier - The amount to multiply the duration between each tick by
  - getSpeedMultiplier
```
public float getSpeedMultiplier()
```
    Retrieves the current multiplier used for the current time calculations. NOTE: the default is 1
    
    Returns:
    
    The current multiplier
  - 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
  - getTimeInt
```
public int getTimeInt()
```
    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

Class StopWatch

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HANDLER_THREAD_NAME

DEFAULT_TICK_DELAY

isRunning

tickDelay

delayedHandler

handlerThread

useHandlerThread

listener

tickRunnable

startTime

currentTime

storedTime

speedMultiplier

Constructor Detail

StopWatch

StopWatch

StopWatch

Method Detail

setTickDelay

getTickDelay

setSpeedMultiplier

getSpeedMultiplier

start

stop

reset

overrideCurrentTime

isRunning

getTime

getTimeInt

setTickListener