Package com.sportradar.livedata.sdk.common.timer

Class PeriodicTimer

java.lang.Object

com.sportradar.livedata.sdk.common.timer.PeriodicTimer

All Implemented Interfaces:

Timer

public class PeriodicTimer
extends Object
implements Timer

A Timer implementation which raises it's events on a background thread.

Author:

uros.bregar

Constructor Summary

Constructors

Constructor	Description
PeriodicTimer(ScheduledExecutorService executorService)	Initializes a new instance of the PeriodicTimer class.

Method Summary

Modifier and Type	Method	Description
void	schedule(org.joda.time.Duration initialDelay, org.joda.time.Duration period)	Schedules a periodic event with specified initialDelay and period.
void	scheduleOneShot(org.joda.time.Duration delay)	Schedules an one-time event to be trigger after time interval specified by passed Duration.
void	setListener(TimerListener listener)	Sets the TimerListener observation used to observe this Timer implementation
void	stop()	Un-schedules any events previously registered with calls to Timer.scheduleOneShot(org.joda.time.Duration) or Timer.schedule(org.joda.time.Duration, org.joda.time.Duration).

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodicTimer

public PeriodicTimer(ScheduledExecutorService executorService)

Initializes a new instance of the PeriodicTimer class.

Parameters:

executorService - The ScheduledExecutorService used to schedule the timer's events.

Throws:

IllegalArgumentException - The executorService is a null reference or initialDelay is smaller than zero or period is smaller than or equal to zero.

Method Detail

setListener

public void setListener(TimerListener listener)

Sets the TimerListener observation used to observe this Timer implementation

Specified by:

setListener in interface Timer

Parameters:

listener - The TimerListener instance used to observe this Timer or a null reference.

scheduleOneShot

public void scheduleOneShot(org.joda.time.Duration delay)

Schedules an one-time event to be trigger after time interval specified by passed Duration. Any events scheduled by previous calls to either Timer.scheduleOneShot(org.joda.time.Duration) or Timer.schedule(org.joda.time.Duration, org.joda.time.Duration) are un-scheduled by this call.

Specified by:

scheduleOneShot in interface Timer

Parameters:

delay - Specifies the time interval after which the one shot event will be triggered.

Throws:

IllegalArgumentException - The delay is a null reference.

schedule

public void schedule(org.joda.time.Duration initialDelay,
                     org.joda.time.Duration period)

Schedules a periodic event with specified initialDelay and period. Any events scheduled by previous calls to either Timer.scheduleOneShot(org.joda.time.Duration) or Timer.schedule(org.joda.time.Duration, org.joda.time.Duration) are un-scheduled by this call.

Specified by:

schedule in interface Timer

Parameters:

initialDelay - Specifies the time interval after which the one shot event will be triggered.

period - Specifies the timer period.

Throws:

IllegalArgumentException - The initialDelay is a null reference or period is a null reference.

stop

public void stop()

Un-schedules any events previously registered with calls to Timer.scheduleOneShot(org.joda.time.Duration) or Timer.schedule(org.joda.time.Duration, org.joda.time.Duration). If no events were scheduled it does nothing.

Specified by:

stop in interface Timer