fr.liglab.adele.icasa.clock

Interface Clock

public interface Clock

This class represents the platform clock. It's provided as an OSGi service.

Author:

Gabriel Pedraza Ferreira

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ClockListener listener) Adds a listener to the clock.
long	currentTimeMillis() Returns the current time in (virtual) milliseconds.
long	getElapsedTime() gets the elapsed time in (virtual) milliseconds from the start date.
int	getFactor() Returns the clock factor.
String	getId() Returns the identifier of the clock.
long	getStartDate() Returns the clock start date.
boolean	isPaused() Returns true if the clock is paused, false otherwise
void	pause() Pauses the (virtual) time flowing.
void	pause(boolean notify) Pauses the (virtual) time flowing.
void	removeListener(ClockListener listener) Removes a listener from the clock.
void	reset() Sets the elapsed time to 0 and pauses the (virtual) time flowing.
void	resume() Resumes the (virtual) time flowing.
void	resume(boolean notify) Resumes the (virtual) time flowing.
void	setFactor(int factor) Set the clock factor (speed of virtual time)
void	setStartDate(long startDate) Sets the start date of the clock.

Method Detail

getId

String getId()

Returns the identifier of the clock.

Returns:

the identifier of the clock.

currentTimeMillis

long currentTimeMillis()

Returns the current time in (virtual) milliseconds.

Returns:

current time.

setStartDate

void setStartDate(long startDate)

Sets the start date of the clock.

Parameters:

startDate - the new start date.

setFactor

void setFactor(int factor)

Set the clock factor (speed of virtual time)

Parameters:

factor - the new factor.

getElapsedTime

long getElapsedTime()

gets the elapsed time in (virtual) milliseconds from the start date.

Returns:

the elapsed time.

pause

void pause()

Pauses the (virtual) time flowing.

resume

void resume()

Resumes the (virtual) time flowing.

pause

void pause(boolean notify)

Pauses the (virtual) time flowing.

Parameters:

notify - True to notify listeners, false if not.

resume

void resume(boolean notify)

Resumes the (virtual) time flowing.

Parameters:

notify - True to notify listeners, false if not.

reset

void reset()

Sets the elapsed time to 0 and pauses the (virtual) time flowing.

getFactor

int getFactor()

Returns the clock factor.

Returns:

the clock factor.

getStartDate

long getStartDate()

Returns the clock start date.

Returns:

the start date.

isPaused

boolean isPaused()

Returns true if the clock is paused, false otherwise

Returns:

boolean to know id the clock is paused

addListener

void addListener(ClockListener listener)

Adds a listener to the clock.

Parameters:

listener - The listener to be added.

removeListener

void removeListener(ClockListener listener)

Removes a listener from the clock.

Parameters:

listener - The listener to be removed.