Package org.jboss.util.collection

Interface Queue<E>

  • Type Parameters:
    E - the element type
    All Superinterfaces:
    java.util.Collection<E>, java.lang.Iterable<E>
    All Known Implementing Classes:
    AbstractQueue, ListQueue
    public interface Queue<E>
extends java.util.Collection<E>
    An iterface used to implement a first-in, first-out container.
    Version:
    $Revision$

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int UNLIMITED_MAXIMUM_SIZE
      Unlimited maximum queue size identifier.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean add​(E obj)
      Enqueue an object onto the queue.
      E getBack()
      Get the object at the back of the queue.
      E getFront()
      Get the object at the front of the queue.
      int getMaximumSize()
      Get the maximum size of the queue.
      boolean isEmpty()
      Check if the queue is empty.
      boolean isFull()
      Check if the queue is full.
      E remove()
      Dequeue an object from the queue.
      void setMaximumSize​(int size)
      Set the maximum size of the queue.

      • Methods inherited from interface java.util.Collection

        addAll, clear, contains, containsAll, equals, hashCode, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

    • Field Detail

      • UNLIMITED_MAXIMUM_SIZE

        static final int UNLIMITED_MAXIMUM_SIZE
        Unlimited maximum queue size identifier.
        See Also:
        Constant Field Values

    • Method Detail

      • getMaximumSize

        int getMaximumSize()
        Get the maximum size of the queue.
        Returns:
        Maximum pool size or UNLIMITED_MAXIMUM_SIZE.

      • setMaximumSize

        void setMaximumSize​(int size)
             throws java.lang.IllegalArgumentException
        Set the maximum size of the queue.
        Parameters:
        size - New maximim pool size or UNLIMITED_MAXIMUM_SIZE.
        Throws:
        java.lang.IllegalArgumentException - Illegal size.

      • isFull

        boolean isFull()
        Check if the queue is full.
        Returns:
        True if the queue is full.

      • isEmpty

        boolean isEmpty()
        Check if the queue is empty.
        Specified by:
        isEmpty in interface java.util.Collection<E>
        Returns:
        True if the queue is empty.

      • add

        boolean add​(E obj)
     throws FullCollectionException
        Enqueue an object onto the queue.
        Specified by:
        add in interface java.util.Collection<E>
        Parameters:
        obj - Object to enqueue.
        Returns:
        True if collection was modified.
        Throws:
        FullCollectionException - The queue is full.