com.salesforce.omakase.broadcast

Class QueuingBroadcaster

java.lang.Object

com.salesforce.omakase.broadcast.AbstractBroadcaster

com.salesforce.omakase.broadcast.QueuingBroadcaster

All Implemented Interfaces:

Broadcaster

public final class QueuingBroadcaster
extends AbstractBroadcaster

A broadcaster that queues broadcasts.

Broadcasts can be paused with pause() and resumed with resume(). The queue operates on a FIFO basis.

Field Summary

Fields inherited from class com.salesforce.omakase.broadcast.AbstractBroadcaster

next

Constructor Summary

Constructors

Constructor and Description
QueuingBroadcaster(Broadcaster broadcaster) Creates a new QueuingBroadcaster and calls AbstractBroadcaster.chain(Broadcaster) on this instance, passing in the given Broadcaster.

Method Summary

Modifier and Type	Method and Description
Iterable<Broadcastable>	all() Gets a a view of all items in the queue.
void	broadcast(Broadcastable broadcastable) Broadcasts the given event (syntax unit).
QueuingBroadcaster	pause() Pauses the queue.
Broadcastable	peek() Retrieves, but does not remove the first item in the queue.
Broadcastable	peekLast() Retrieves, but does not remove the last item in the queue.
QueuingBroadcaster	reject(Broadcastable broadcastable) Prevents the given Broadcastable unit, if it currently exists in the queue, from being broadcasted once resume() is called.
QueuingBroadcaster	resume() Resumes broadcasts.
int	size() Gets the count of the items currently in the queue.

Methods inherited from class com.salesforce.omakase.broadcast.AbstractBroadcaster

chain, chainBroadcast, cut, relay

Methods inherited from class java.lang.Object

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

Constructor Detail

QueuingBroadcaster

public QueuingBroadcaster(Broadcaster broadcaster)

Creates a new QueuingBroadcaster and calls AbstractBroadcaster.chain(Broadcaster) on this instance, passing in the given Broadcaster.

Parameters:

broadcaster - Add this broadcaster to the end of the chain. This will receive all broadcasts when the queue is not paused or when it resumes.

Method Detail

broadcast

public void broadcast(Broadcastable broadcastable)

Description copied from interface: Broadcaster

Broadcasts the given event (syntax unit).

Parameters:

broadcastable - The Broadcastable syntax unit.

pause

public QueuingBroadcaster pause()

Pauses the queue. While pause, all broadcasts will be stored and will not be relayed until resume() is called.

Returns:

this, for chaining.

resume

public QueuingBroadcaster resume()

Resumes broadcasts. Any broadcasts currently in the queue will be immediately sent out.

Returns:

this, for chaining.

size

public int size()

Gets the count of the items currently in the queue.

Returns:

Number of items in the queue.

peek

public Broadcastable peek()

Retrieves, but does not remove the first item in the queue.

Returns:

The first item in the queue.

peekLast

public Broadcastable peekLast()

Retrieves, but does not remove the last item in the queue.

Returns:

The last item in the queue.

all

public Iterable<Broadcastable> all()

Gets a a view of all items in the queue.

Returns:

All units in the queue.

reject

public QueuingBroadcaster reject(Broadcastable broadcastable)

Prevents the given Broadcastable unit, if it currently exists in the queue, from being broadcasted once resume() is called.

Parameters:

broadcastable - The Broadcastable unit to reject.

Returns:

this, for chaining.