package

org.apache.commons.collections

This package contains the interfaces and utilities shared across all the subpackages of this component.

The following collection implementations are provided in the package:

  • ArrayStack - a non synchronized Stack that follows the same API as java util Stack
  • ExtendedProperties - extends the Properties class to add extra functionality

Interfaces

Bag Defines a collection that counts the number of times an object appears in the collection. 
BidiMap Defines a map that allows bidirectional lookup between key and values. 
BoundedCollection Defines a collection that is bounded in size. 
BoundedMap Defines a map that is bounded in size. 
Buffer Defines a collection that allows objects to be removed in some well-defined order. 
Closure Defines a functor interface implemented by classes that do something. 
Factory Defines a functor interface implemented by classes that create objects. 
IterableMap Defines a map that can be iterated directly without needing to create an entry set. 
KeyValue Defines a simple key value pair. 
MapIterator Defines an iterator that operates over a Map
MultiMap Defines a map that holds a collection of values against each key. 
OrderedBidiMap Defines a map that allows bidirectional lookup between key and values and retains and provides access to an ordering. 
OrderedIterator Defines an iterator that operates over an ordered collection. 
OrderedMap Defines a map that maintains order and allows both forward and backward iteration through that order. 
OrderedMapIterator Defines an iterator that operates over an ordered Map
Predicate Defines a functor interface implemented by classes that perform a predicate test on an object. 
PriorityQueue This interface is deprecated. Replaced by the Buffer interface and implementations in buffer subpackage. Due to be removed in v4.0. 
ResettableIterator Defines an iterator that can be reset back to an initial state. 
ResettableListIterator Defines a list iterator that can be reset back to an initial state. 
SortedBag Defines a type of Bag that maintains a sorted order among its unique representative members. 
SortedBidiMap Defines a map that allows bidirectional lookup between key and values and retains both keys and values in sorted order. 
Transformer Defines a functor interface implemented by classes that transform one object into another. 
Unmodifiable Marker interface for collections, maps and iterators that are unmodifiable. 

Classes

ArrayStack An implementation of the java.util.Stack API that is based on an ArrayList instead of a Vector, so it is not synchronized to protect against multi-threaded access. 
BagUtils Provides utility methods and decorators for Bag and SortedBag instances. 
BeanMap This class is deprecated. Identical class now available in commons-beanutils (full jar version). This version is due to be removed in collections v4.0.  
BeanMap.MyMapEntry Map entry used by BeanMap
BinaryHeap This class is deprecated. Replaced by PriorityBuffer in buffer subpackage. Due to be removed in v4.0. 
BoundedFifoBuffer This class is deprecated. Moved to buffer subpackage. Due to be removed in v4.0. 
BufferUtils Provides utility methods and decorators for Buffer instances. 
ClosureUtils ClosureUtils provides reference implementations and utilities for the Closure functor interface. 
CollectionUtils Provides utility methods and decorators for Collection instances. 
ComparatorUtils Provides convenient static utility methods for Comparator objects. 
CursorableLinkedList This class is deprecated. Use new version in list subpackage, which has been rewritten and now returns the cursor from the listIterator method. Will be removed in v4.0 
CursorableLinkedList.Cursor  
DefaultMapBag This class is deprecated. Moved to bag subpackage as AbstractMapBag. Due to be removed in v4.0. 
DefaultMapEntry This class is deprecated. Use the version in the keyvalue subpackage. Will be removed in v4.0 
DoubleOrderedMap This class is deprecated. Replaced by TreeBidiMap in bidimap subpackage. Due to be removed in v4.0. 
EnumerationUtils Provides utility methods for Enumeration instances. 
ExtendedProperties This class extends normal Java properties by adding the possibility to use the same key many times concatenating the value strings instead of overwriting them. 
FactoryUtils FactoryUtils provides reference implementations and utilities for the Factory functor interface. 
FastArrayList

A customized implementation of java.util.ArrayList designed to operate in a multithreaded environment where the large majority of method calls are read-only, instead of structural changes. 

FastHashMap

A customized implementation of java.util.HashMap designed to operate in a multithreaded environment where the large majority of method calls are read-only, instead of structural changes. 

FastTreeMap

A customized implementation of java.util.TreeMap designed to operate in a multithreaded environment where the large majority of method calls are read-only, instead of structural changes. 

HashBag This class is deprecated. Moved to bag subpackage and rewritten internally. Due to be removed in v4.0. 
IteratorUtils Provides static utility methods and decorators for Iterator instances. 
ListUtils Provides utility methods and decorators for List instances. 
LRUMap This class is deprecated. Moved to map subpackage. Due to be removed in v4.0. 
MapUtils Provides utility methods and decorators for Map and SortedMap instances. 
MultiHashMap This class is deprecated. Class now available as MultiValueMap in map subpackage. This version is due to be removed in collections v4.0. 
PredicateUtils PredicateUtils provides reference implementations and utilities for the Predicate functor interface. 
ProxyMap This class is deprecated. Moved to map subpackage as AbstractMapDecorator. It will be removed in v4.0. 
ReferenceMap This class is deprecated. Moved to map subpackage. Due to be removed in v4.0. 
SequencedHashMap This class is deprecated. Replaced by LinkedMap and ListOrderedMap in map subpackage. Due to be removed in v4.0. 
SetUtils Provides utility methods and decorators for Set and SortedSet instances. 
StaticBucketMap This class is deprecated. Moved to map subpackage. Due to be removed in v4.0. 
SynchronizedPriorityQueue This class is deprecated. PriorityQueue is replaced by the Buffer interface, see buffer subpackage. Due to be removed in v4.0. 
TransformerUtils TransformerUtils provides reference implementations and utilities for the Transformer functor interface. 
TreeBag This class is deprecated. Moved to bag subpackage and rewritten internally. Due to be removed in v4.0. 
UnboundedFifoBuffer This class is deprecated. Moved to buffer subpackage. Due to be removed in v4.0. 

Exceptions

BufferOverflowException The BufferOverflowException is used when the buffer's capacity has been exceeded. 
BufferUnderflowException The BufferUnderflowException is used when the buffer is already empty. 
FunctorException Runtime exception thrown from functors.