Package io.microsphere.concurrent

Class DelegatingBlockingQueue<E>

  • Type Parameters:
    E - The type of elements held in this queue.
    All Implemented Interfaces:
    java.lang.Iterable<E>, java.util.Collection<E>, java.util.concurrent.BlockingQueue<E>, java.util.Queue<E>
    public class DelegatingBlockingQueue<E>
extends java.lang.Object
implements java.util.concurrent.BlockingQueue<E>
    A delegating implementation of BlockingQueue that wraps another BlockingQueue instance and forwards all method calls to it.

    This class can be used as a base class for decorators that add functionality to a BlockingQueue, such as adding instrumentation, validation, or other cross-cutting concerns.

    Example Usage

    
 BlockingQueue<String> delegate = new LinkedBlockingQueue<>();
 DelegatingBlockingQueue<String> queue = new DelegatingBlockingQueue<>(delegate);

 queue.put("item");              // Adds an element to the queue
 String item = queue.take();     // Retrieves and removes an element
    Since:
    1.0.0
    Author:
    Mercy

    • Constructor Summary

      Constructors 
      Constructor Description
      DelegatingBlockingQueue​(java.util.concurrent.BlockingQueue<E> delegate)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(E e)  
      boolean addAll​(java.util.Collection<? extends E> c)  
      void clear()  
      boolean contains​(java.lang.Object o)  
      boolean containsAll​(java.util.Collection<?> c)  
      int drainTo​(java.util.Collection<? super E> c)  
      int drainTo​(java.util.Collection<? super E> c, int maxElements)  
      E element()  
      boolean equals​(java.lang.Object o)  
      void forEach​(java.util.function.Consumer<? super E> action)  
      int hashCode()  
      boolean isEmpty()  
      java.util.Iterator<E> iterator()  
      boolean offer​(E e)  
      boolean offer​(E e, long timeout, java.util.concurrent.TimeUnit unit)  
      java.util.stream.Stream<E> parallelStream()  
      E peek()  
      E poll()  
      E poll​(long timeout, java.util.concurrent.TimeUnit unit)  
      void put​(E e)  
      int remainingCapacity()  
      E remove()  
      boolean remove​(java.lang.Object o)  
      boolean removeAll​(java.util.Collection<?> c)  
      boolean removeIf​(java.util.function.Predicate<? super E> filter)  
      boolean retainAll​(java.util.Collection<?> c)  
      int size()  
      java.util.Spliterator<E> spliterator()  
      java.util.stream.Stream<E> stream()  
      E take()  
      java.lang.Object[] toArray()  
      <T> T[] toArray​(T[] a)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DelegatingBlockingQueue

        public DelegatingBlockingQueue​(java.util.concurrent.BlockingQueue<E> delegate)

    • Method Detail

      • iterator

        public java.util.Iterator<E> iterator()
        Specified by:
        iterator in interface java.util.Collection<E>
        Specified by:
        iterator in interface java.lang.Iterable<E>

      • toArray

        public java.lang.Object[] toArray()
        Specified by:
        toArray in interface java.util.Collection<E>

      • toArray

        public <T> T[] toArray​(T[] a)
        Specified by:
        toArray in interface java.util.Collection<E>

      • containsAll

        public boolean containsAll​(java.util.Collection<?> c)
        Specified by:
        containsAll in interface java.util.Collection<E>

      • addAll

        public boolean addAll​(java.util.Collection<? extends E> c)
        Specified by:
        addAll in interface java.util.Collection<E>

      • removeAll

        public boolean removeAll​(java.util.Collection<?> c)
        Specified by:
        removeAll in interface java.util.Collection<E>

      • removeIf

        public boolean removeIf​(java.util.function.Predicate<? super E> filter)
        Specified by:
        removeIf in interface java.util.Collection<E>

      • retainAll

        public boolean retainAll​(java.util.Collection<?> c)
        Specified by:
        retainAll in interface java.util.Collection<E>

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Collection<E>

      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in interface java.util.Collection<E>
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Collection<E>
        Overrides:
        hashCode in class java.lang.Object

      • spliterator

        public java.util.Spliterator<E> spliterator()
        Specified by:
        spliterator in interface java.util.Collection<E>
        Specified by:
        spliterator in interface java.lang.Iterable<E>

      • stream

        public java.util.stream.Stream<E> stream()
        Specified by:
        stream in interface java.util.Collection<E>

      • parallelStream

        public java.util.stream.Stream<E> parallelStream()
        Specified by:
        parallelStream in interface java.util.Collection<E>

      • add

        public boolean add​(E e)
        Specified by:
        add in interface java.util.concurrent.BlockingQueue<E>
        Specified by:
        add in interface java.util.Collection<E>
        Specified by:
        add in interface java.util.Queue<E>

      • offer

        public boolean offer​(E e)
        Specified by:
        offer in interface java.util.concurrent.BlockingQueue<E>
        Specified by:
        offer in interface java.util.Queue<E>

      • put

        public void put​(E e)
         throws java.lang.InterruptedException
        Specified by:
        put in interface java.util.concurrent.BlockingQueue<E>
        Throws:
        java.lang.InterruptedException

      • offer

        public boolean offer​(E e,
                     long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException
        Specified by:
        offer in interface java.util.concurrent.BlockingQueue<E>
        Throws:
        java.lang.InterruptedException

      • take

        public E take()
       throws java.lang.InterruptedException
        Specified by:
        take in interface java.util.concurrent.BlockingQueue<E>
        Throws:
        java.lang.InterruptedException

      • poll

        public E poll​(long timeout,
              java.util.concurrent.TimeUnit unit)
       throws java.lang.InterruptedException
        Specified by:
        poll in interface java.util.concurrent.BlockingQueue<E>
        Throws:
        java.lang.InterruptedException

      • remainingCapacity

        public int remainingCapacity()
        Specified by:
        remainingCapacity in interface java.util.concurrent.BlockingQueue<E>

      • remove

        public boolean remove​(java.lang.Object o)
        Specified by:
        remove in interface java.util.concurrent.BlockingQueue<E>
        Specified by:
        remove in interface java.util.Collection<E>

      • contains

        public boolean contains​(java.lang.Object o)
        Specified by:
        contains in interface java.util.concurrent.BlockingQueue<E>
        Specified by:
        contains in interface java.util.Collection<E>

      • drainTo

        public int drainTo​(java.util.Collection<? super E> c)
        Specified by:
        drainTo in interface java.util.concurrent.BlockingQueue<E>

      • drainTo

        public int drainTo​(java.util.Collection<? super E> c,
                   int maxElements)
        Specified by:
        drainTo in interface java.util.concurrent.BlockingQueue<E>

      • remove

        public E remove()
        Specified by:
        remove in interface java.util.Queue<E>

      • poll

        public E poll()
        Specified by:
        poll in interface java.util.Queue<E>

      • element

        public E element()
        Specified by:
        element in interface java.util.Queue<E>

      • peek

        public E peek()
        Specified by:
        peek in interface java.util.Queue<E>

      • size

        public int size()
        Specified by:
        size in interface java.util.Collection<E>

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface java.util.Collection<E>

      • forEach

        public void forEach​(java.util.function.Consumer<? super E> action)
        Specified by:
        forEach in interface java.lang.Iterable<E>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object