BoundedCollection (Apache Commons Collections 4.0 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

Version:

$Id: BoundedCollection.java 1477779 2013-04-30 18:55:24Z tn $

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

Method Summary

Methods
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, remove, removeAll, retainAll, size, toArray, toArray

- 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

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.