OpenNMS API 1.2.3

org.opennms.core.queue
Interface BoundedFifoQueue

All Superinterfaces:
FifoQueue

public interface BoundedFifoQueue
extends FifoQueue

This interface is used to define a queue with First In, First Out semantics that has a maximum input size. The base interface class defines the methods for preforming the first in, first out queue algorithm. This interface is used to mark an implementation as having a maximum size in the number of elements that can be added to the queue.

Once the maximum size is reached it is up to the implementation to determine if it should block the adding thread, or generate an exception.

Author:
Brian Weaver , OpenNMS

Method Summary
 boolean isFull()
          Returns true if the queue has reached the maximum number of elements it can hold.
 int maxSize()
          Returns the maximum number of elements that can be contained in the FIFO queue.
 
Methods inherited from interface org.opennms.core.queue.FifoQueue
add, add, isEmpty, remove, remove, size
 

Method Detail

maxSize

public int maxSize()
Returns the maximum number of elements that can be contained in the FIFO queue.

Returns:
The maximum number of elements storable in the queue.

isFull

public boolean isFull()
Returns true if the queue has reached the maximum number of elements it can hold.

Returns:
True if the queue is at maximum capacity.

OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.