org.squirrelframework.foundation.component

Interface Heartbeat

All Known Implementing Classes:

HeartbeatImpl

public interface Heartbeat

Allows for deferred execution of logic, useful when trying to get multiple components to coordinate behavior. A component may add a command to be executed "at the end of the heartbeat". Also, Heartbeats can be nested.

Method Summary

Methods

Modifier and Type	Method and Description
void	begin() Begins a new Heartbeat.
void	defer(Runnable command) Adds a new command to the current Heartbeat.
void	execute() Executes all commands since the most recent begin().

Method Detail

begin

void begin()

Begins a new Heartbeat. Heartbeats nest. Every call to begin() should be matched by a call to execute().

execute

void execute()

Executes all commands since the most recent begin().

defer

void defer(Runnable command)

Adds a new command to the current Heartbeat. The command will be executed by execute().

Parameters:

command - command to be executed at the end of the heartbeat