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

Interface Timer

All Known Implementing Classes:

PeriodicTimer

public interface Timer

Represents a timer used to trigger periodic events.

Author:

uros.bregar

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 scheduleOneShot(org.joda.time.Duration) or schedule(org.joda.time.Duration, org.joda.time.Duration).

Method Detail

setListener

void setListener(TimerListener listener)

Sets the TimerListener observation used to observe this Timer implementation

Parameters:

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

scheduleOneShot

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 scheduleOneShot(org.joda.time.Duration) or schedule(org.joda.time.Duration, org.joda.time.Duration) are un-scheduled by this call.

Parameters:

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

Throws:

IllegalArgumentException - The delay is a null reference.

schedule

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 scheduleOneShot(org.joda.time.Duration) or schedule(org.joda.time.Duration, org.joda.time.Duration) are un-scheduled by this call.

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

void stop()

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