Package org.apache.commons.collections

Interface Buffer

  • All Superinterfaces:
    java.util.Collection, java.lang.Iterable
    All Known Implementing Classes:
    AbstractBufferDecorator, ArrayStack, BinaryHeap, BlockingBuffer, BoundedBuffer, BoundedFifoBuffer, BoundedFifoBuffer, CircularFifoBuffer, PredicatedBuffer, PriorityBuffer, SynchronizedBuffer, TransformedBuffer, UnboundedFifoBuffer, UnboundedFifoBuffer, UnmodifiableBuffer
    @Deprecated(since="2021-04-30")
public interface Buffer
extends java.util.Collection
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    Defines a collection that allows objects to be removed in some well-defined order.

    The removal order can be based on insertion order (eg, a FIFO queue or a LIFO stack), on access order (eg, an LRU cache), on some arbitrary comparator (eg, a priority queue) or on any other well-defined ordering.

    Note that the removal order is not necessarily the same as the iteration order. A Buffer implementation may have equivalent removal and iteration orders, but this is not required.

    This interface does not specify any behavior for Object.equals(Object) and Object.hashCode() methods. It is therefore possible for a Buffer implementation to also also implement List, Set or Bag.

    Since:
    Commons Collections 2.1

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.Object get()
      Deprecated.
      Gets the next object from the buffer without removing it.
      java.lang.Object remove()
      Deprecated.
      Gets and removes the next object from the buffer.

      • Methods inherited from interface java.util.Collection

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

      • Methods inherited from interface java.lang.Iterable

        forEach

    • Method Detail

      • remove

        java.lang.Object remove()
        Deprecated.
        Gets and removes the next object from the buffer.
        Returns:
        the next object in the buffer, which is also removed
        Throws:
        BufferUnderflowException - if the buffer is already empty

      • get

        java.lang.Object get()
        Deprecated.
        Gets the next object from the buffer without removing it.
        Returns:
        the next object in the buffer, which is not removed
        Throws:
        BufferUnderflowException - if the buffer is empty