org.apache.commons.collections4

Interface BoundedCollection<E>

Type Parameters:

E - the type of elements in this collection

All Superinterfaces:

Collection<E>, Iterable<E>

All Known Implementing Classes:

CircularFifoQueue, FixedSizeList, UnmodifiableBoundedCollection

public interface BoundedCollection<E>
extends Collection<E>

Defines a collection that is bounded in size.

The size of the collection can vary, but it can never exceed a preset maximum number of elements. This interface allows the querying of details associated with the maximum number of elements.

Since:

3.0

See Also:

CollectionUtils.isFull(java.util.Collection<? extends java.lang.Object>), CollectionUtils.maxSize(java.util.Collection<? extends java.lang.Object>)

Method Summary

Modifier and Type	Method and Description
boolean	isFull() Returns true if this collection is full and no new elements can be added.
int	maxSize() Gets the maximum size of the collection (the bound).

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

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

isFull

boolean isFull()

Returns true if this collection is full and no new elements can be added.

Returns:

true if the collection is full

maxSize

int maxSize()

Gets the maximum size of the collection (the bound).

Returns:

the maximum number of elements the collection can hold