Package org.kiwiproject.collect

Class KiwiEvictingQueues

java.lang.Object

org.kiwiproject.collect.KiwiEvictingQueues

public class KiwiEvictingQueues
extends Object

Utility methods for working with Guava EvictingQueue instances.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_RECENT_ITEMS	The default maximum number of EvictingQueue items.

Constructor Summary

Constructors

Constructor	Description
KiwiEvictingQueues()

Method Summary

Modifier and Type	Method	Description
static <T> Queue<T>	synchronizedEvictingQueue()	Create a new, synchronized EvictingQueue that can hold up to DEFAULT_MAX_RECENT_ITEMS items.
static <T> Queue<T>	synchronizedEvictingQueue(int maxSize)	Create a new, synchronized EvictingQueue that can hold up to maxSize items.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_RECENT_ITEMS

public static final int DEFAULT_MAX_RECENT_ITEMS

The default maximum number of EvictingQueue items.

See Also:

synchronizedEvictingQueue(), Constant Field Values

Constructor Detail

KiwiEvictingQueues

public KiwiEvictingQueues()

Method Detail

synchronizedEvictingQueue

public static <T> Queue<T> synchronizedEvictingQueue()

Create a new, synchronized EvictingQueue that can hold up to DEFAULT_MAX_RECENT_ITEMS items.

Type Parameters:

T - the type in the queue

Returns:

a synchronized EvictingQueue

See Also:

Queues.synchronizedQueue(Queue)

API Note:

returns a plain Queue because Guava's Queues.synchronizedQueue(Queue) returns a Queue. Any attempt to cast to an EvictingQueue will result in a ClassCastException.

Implementation Note:

See synchronized notes regarding manual synchronization of the returned queue's Iterator in Queues.synchronizedQueue(Queue)

synchronizedEvictingQueue

public static <T> Queue<T> synchronizedEvictingQueue(int maxSize)

Create a new, synchronized EvictingQueue that can hold up to maxSize items.

Type Parameters:

T - the type in the queue

Parameters:

maxSize - maximum size for the queue

Returns:

a synchronized EvictingQueue

See Also:

Queues.synchronizedQueue(Queue)

API Note:

returns a plain Queue because Guava's Queues.synchronizedQueue(Queue) returns a Queue. Any attempt to cast to an EvictingQueue will result in a ClassCastException.

Implementation Note:

See synchronized notes regarding manual synchronization of the returned queue's Iterator in Queues.synchronizedQueue(Queue)