xapi.gwt.collect

Class JsFifo<E>

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

xapi.gwt.collect.JsFifo<E>

All Implemented Interfaces:

Fifo<E>

public class JsFifo<E>
extends com.google.gwt.core.client.JavaScriptObject
implements Fifo<E>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsFifo()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all items in the queue.
boolean	contains(E item) Check if this queue contains the given item.
Iterable<E>	forEach()
Fifo<E>	give(E item) Analagous to add(), however, we do not use the standard naming convention, to avoid interface clashes with adapter types in collection libraries that may wish to override our Fifo with their own type.
Fifo<E>	giveAll(E... elements) Analagous to addAll(), however, we avoid the standard naming convention, so we can provide a fluent, strongly typed api.
Fifo<E>	giveAll(Iterable<E> elements) Analagous to addAll(), however, we avoid the standard naming convention, so we can provide a fluent, strongly typed api.
boolean	isEmpty() Fastest way to tell if the queue is drained.
Iterator<E>	iterator()
String	join(String delim)
static <E> Fifo<E>	newFifo()
boolean	remove(E item) Manually remove the item from queue.
int	size() Return a count of items in the queue.
E	take() Analagous to poll(); retrieves and removes head.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JsFifo

protected JsFifo()

Method Detail

newFifo

public static <E> Fifo<E> newFifo()

clear

public final void clear()

Description copied from interface: Fifo

Removes all items in the queue. head = tail;

Specified by:

clear in interface Fifo<E>

contains

public final boolean contains(E item)

Description copied from interface: Fifo

Check if this queue contains the given item. O(n) performance. You may want to use a Set unless you know there aren't many items.

Specified by:

contains in interface Fifo<E>

Returns:

give

public final Fifo<E> give(E item)

Description copied from interface: Fifo

Analagous to add(), however, we do not use the standard naming convention, to avoid interface clashes with adapter types in collection libraries that may wish to override our Fifo with their own type.

Specified by:

give in interface Fifo<E>

Parameters:

item - - The item to add to end of queue.

Returns:

this queue

giveAll

public final Fifo<E> giveAll(E... elements)

Description copied from interface: Fifo

Analagous to addAll(), however, we avoid the standard naming convention, so we can provide a fluent, strongly typed api. Also, since the javascript object, JsFifo, is an array itself, the "cost" of the varargs is diminished because we can just 'cat them together.

Specified by:

giveAll in interface Fifo<E>

Parameters:

elements - - Varags or array adapters for bulk add.

Returns:

- this

giveAll

public final Fifo<E> giveAll(Iterable<E> elements)

Description copied from interface: Fifo

Analagous to addAll(), however, we avoid the standard naming convention, so we can provide a fluent, strongly typed api.

Specified by:

giveAll in interface Fifo<E>

Parameters:

elements - - Any collection or custom iterable adapters (like blocking / async).

Returns:

- this

isEmpty

public final boolean isEmpty()

Description copied from interface: Fifo

Fastest way to tell if the queue is drained.

Specified by:

isEmpty in interface Fifo<E>

Returns:

true if head == tail (there are no elements)

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Fifo<E>

Returns:

An iterator for the items in the queue. We do NOT implement Iterable, otherwise GWT JSOs will have a fit.

forEach

public final Iterable<E> forEach()

Specified by:

forEach in interface Fifo<E>

Returns:

an Iterable for these items; JRE runtimes will likely return this; GWT runtimes will return an iterable object.

remove

public final boolean remove(E item)

Description copied from interface: Fifo

Manually remove the item from queue. O(n) performance.

Specified by:

remove in interface Fifo<E>

Returns:

size

public final int size()

Description copied from interface: Fifo

Return a count of items in the queue. Default implementation uses a counter; subclasses may have O(n) if they must transverse the nodes to get a count.

Specified by:

size in interface Fifo<E>

Returns:

take

public final E take()

Description copied from interface: Fifo

Analagous to poll(); retrieves and removes head. We avoid the use of standard queue naming methods, in case an api to be injected uses Object instead of <Generic>

Specified by:

take in interface Fifo<E>

Returns:

and remove the head of the queue

join

public final String join(String delim)

Specified by:

join in interface Fifo<E>