com.github.kayak.core

Class TimeSource

java.lang.Object

com.github.kayak.core.TimeSource

public class TimeSource
extends java.lang.Object

This class is used to synchronize the time between different busses or other classes. After a TimeSource is created it can be connected to any number of objects. Objects can either simply call getTime() to receive the time or register themselves to receive TimeEvents via the TimeEventReceiver interface. This can be used to synchronize multiple components.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeSource.Mode

Constructor Summary

Constructors

Constructor and Description
TimeSource()

Method Summary

Modifier and Type	Method and Description
void	deregister(TimeEventReceiver receiver)
TimeSource.Mode	getMode()
long	getTime() Returns the time (in milliseconds) since the creation of the TimeSource (or since the last stop).
void	pause() Pauses the time.
void	play() If the TimeSource is not already running start the time.
void	register(TimeEventReceiver receiver) Register a TimeEventReceiver to receive information about changes of the TimeSource.
void	reset()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSource

public TimeSource()

Method Detail

getMode

public TimeSource.Mode getMode()

reset

public void reset()

getTime

public long getTime()

Returns the time (in milliseconds) since the creation of the TimeSource (or since the last stop). A static value is returned if the TimeSource is paused. If the TimeSource is stopped '0' is returned.

register

public void register(TimeEventReceiver receiver)

Register a TimeEventReceiver to receive information about changes of the TimeSource.

deregister

public void deregister(TimeEventReceiver receiver)

play

public void play()

If the TimeSource is not already running start the time. If the TimeSource was paused before continue with the paused Time.

pause

public void pause()

Pauses the time.

stop

public void stop()