Package org.apache.commons.collections

Interface Buffer

All Superinterfaces:

Collection, 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 Collection

Deprecated.

Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.

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

Modifier and Type	Method	Description
Object	get()	Deprecated. Gets the next object from the buffer without removing it.
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 Details

remove

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

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