Keel 2.1RC2

Package org.apache.commons.collections

Java Collections Framework extensions.

See:
          Description

Interface Summary
Bag A Collection that counts the number of times an object appears in the collection.
Buffer A Buffer is a collection that allows objects to be removed in some well-defined order.
Closure An interface to represent some Closure, a block of code which is executed from inside some block, function or iteration which operates on an input object.
Factory Factory A simple interface that describes the most basic means of having the ability to create an object.
MultiMap This is simply a Map with slightly different semantics.
Predicate Performs some predicate which returns true or false based on the input object.
PriorityQueue Interface for priority queues.
SortedBag A type of Bag that maintains order among its unique representative members.
Transformer An object capable of transforming an input object into some output object.
 

Class Summary
ArrayEnumeration Deprecated. This class has significant overlap with ArrayIterator, and Collections focuses mainly on Java2-style collections.
ArrayIterator Deprecated. this class has been moved to the iterators subpackage
ArrayStack An implementation of the 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 BagUtils.PredicatedBag and SortedBag instances.
BagUtils.PredicatedBag  
BagUtils.PredicatedSortedBag  
BagUtils.SynchronizedBag  
BagUtils.SynchronizedSortedBag  
BagUtils.UnmodifiableBag  
BagUtils.UnmodifiableSortedBag  
BeanMap An implementation of Map for JavaBeans which uses introspection to get and put properties in the bean.
BeanMap.MyMapEntry Map entry used by BeanMap.
BinaryHeap Binary heap implementation of PriorityQueue and Buffer.
BoundedFifoBuffer The BoundedFifoBuffer is a very efficient implementation of Buffer that does not alter the size of the buffer at runtime.
BufferUtils Contains static utility methods for operating on BufferUtils.SynchronizedBuffer objects.
BufferUtils.PredicatedBuffer  
BufferUtils.SynchronizedBuffer  
BufferUtils.UnmodifiableBuffer  
BulkTest A TestCase that can define both simple and bulk test methods.
BulkTestSuiteMaker  
CollectionUtils A set of Collection related utility methods.
CollectionUtils.CollectionWrapper Base class for collection decorators.
CollectionUtils.PredicatedCollection  
CollectionUtils.SynchronizedCollection  
CollectionUtils.UnmodifiableCollection  
CollectionUtils.UnmodifiableIterator  
ComparatorUtils Provides convenient static utility methods for Comparator objects.
CursorableLinkedList A doubly-linked list implementation of the List interface, supporting a ListIterator that allows concurrent modifications to the underlying list.
CursorableSubList  
DefaultMapBag This class provides a skeletal implementation of the Bag interface to minimize the effort required for target implementations.
DefaultMapEntry A default implementation of Map.Entry
DoubleOrderedMap Red-Black tree-based implementation of Map.
DoubleOrderedMap.Node  
EnumerationIterator Deprecated. this class has been moved to the iterators subpackage
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.
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.
FilterIterator Deprecated. this class has been moved to the iterators subpackage
FilterListIterator Deprecated. this class has been moved to the iterators subpackage
HashBag An implementation of Bag that is backed by a HashMap.
IteratorEnumeration Deprecated. this class has been moved to the iterators subpackage
IteratorUtils Provides static utility methods and decorators for IteratorUtils.EmptyIterator instances.
IteratorUtils.EmptyIterator EmptyIterator class
IteratorUtils.EmptyListIterator EmptyListIterator class
ListUtils Contains static utility methods and decorators for List instances.
ListUtils.FixedSizeList  
ListUtils.LazyList  
ListUtils.ListIteratorWrapper  
ListUtils.PredicatedList  
LocalTestNode Class LocalTestNode a helper class for TestDoubleOrderedMap
LRUMap An implementation of a Map which has a maximum size and uses a Least Recently Used algorithm to remove items from the Map when the maximum size is reached and new items are added.
MapUtils A helper class for using Map instances.
MapUtils.FixedSizeMap  
MapUtils.FixedSizeSortedMap  
MapUtils.LazyMap  
MapUtils.LazySortedMap  
MapUtils.PredicatedMap  
MapUtils.PredicatedMapEntry  
MapUtils.PredicatedMapEntrySet  
MapUtils.PredicatedSortedMap  
MultiHashMap MultiHashMap is the default implementation of the MultiMap interface.
ProxyIterator Deprecated. this class has been moved to the iterators subpackage
ProxyListIterator Deprecated. this class has been moved to the iterators subpackage
ProxyMap This Map wraps another Map implementation, using the wrapped instance for its default implementation.
ReferenceMap Hashtable-based Map implementation that allows mappings to be removed by the garbage collector.
ReferenceMap.SoftRef  
ReferenceMap.WeakRef  
SequencedHashMap A map of objects whose mapping entries are sequenced based on the order in which they were added.
SequencedHashMap.Entry Map.Entry that doubles as a node in the linked list of sequenced mappings.
SetUtils Provides static utility methods and decorators for SetUtils.PredicatedSet and SortedSet instances.
SetUtils.PredicatedSet  
SetUtils.PredicatedSortedSet  
SingletonIterator Deprecated. this class has been moved to the iterators subpackage
SoftRefHashMap Deprecated. This class is all kinds of wonky; use ReferenceMap instead.
StaticBucketMap A StaticBucketMap is an efficient, thread-safe implementation of java.util.Map that performs well in in a highly thread-contentious environment.
StaticBucketMap.Lock  
StringStack Deprecated. This class is not a Stack, it is a String utility.
SynchronizedPriorityQueue A thread safe version of the PriorityQueue.
TestAll Entry point for all Collections tests.
TestArrayList  
TestArrayStack  
TestBag Tests base Bag methods and contracts.
TestBeanMap Test cases for BeanMap
TestBeanMap.BeanWithProperties  
TestBinaryHeap Tests the BinaryHeap.
TestBoundedFifoBuffer Test cases for BoundedFifoBuffer.
TestBoundedFifoBuffer2 Runs tests against a full BoundedFifoBuffer, since many of the algorithms differ depending on whether the fifo is full or not.
TestBufferUtils Tests for BufferUtils.
TestCollection Tests base Collection methods and contracts.
TestCollectionUtils  
TestCursorableLinkedList  
TestDoubleOrderedMap Class TestDoubleOrderedMap Test cases for DoubleOrderedMap.
TestExtendedProperties Tests some basic functions of the ExtendedProperties class
TestFastArrayList  
TestFastArrayList1 Test FastArrayList implementation in fast mode.
TestFastHashMap  
TestFastHashMap1 Test FastHashMap in fast mode.
TestFastTreeMap  
TestFastTreeMap1 Test FastTreeMap in fast mode.
TestHashBag Extension of TestBag for exercising the HashBag implementation.
TestIteratorUtils Tests for IteratorUtils.
TestList Tests base List methods and contracts.
TestList.BulkTestSubList  
TestListUtils  
TestLRUMap  
TestMap Tests base Map methods and contracts.
TestMapUtils Tests for MapUtils.
TestMultiHashMap Unit Tests for MultiHashMap.
TestMultiHashMap.MapPair  
TestObject Tests base Object methods and contracts.
TestPredicatedCollection  
TestProxyMap Tests the ProxyMap class.
TestReferenceMap Tests for ReferenceMap.
TestSequencedHashMap Unit tests SequencedHashMap.
TestSet Tests base Set methods and contracts.
TestSetUtils Tests for SetUtils.
TestStaticBucketMap Unit tests StaticBucketMap.
TestTreeBag Extension of TestBag for exercising the TreeBag implementation.
TestTreeMap  
TestUnboundedFifoBuffer Test cases for UnboundedFifoBuffer.
TransformIterator Deprecated. this class has been moved to the iterators subpackage
TreeBag An implementation of Bag that is backed by a TreeMap.
UnboundedFifoBuffer UnboundedFifoBuffer is a very efficient buffer implementation.
 

Exception Summary
BufferOverflowException The BufferOverflowException is used when the buffer's capacity has been exceeded.
BufferUnderflowException The BufferUnderflowException is used when the buffer is already empty
 

Package org.apache.commons.collections Description

Java Collections Framework extensions.

See also the java.util package.

Category Classes Comments
List Implementations CursorableLinkedList
FastArrayList
Special-purpose implementations of the List interface.
Map Implementations BeanMap
DoubleOrderedMap
ExtendedProperties
FastHashMap
FastTreeMap
LRUMap
MultiHashMap
ProxyMap
ReferenceMap
SequencedHashMap
SoftRefHashMap
StaticBucketMap
Special-purpose implementations of the Map interface and associated classes.
Buffer Interface and Implementations ArrayStack
BinaryHeap
BoundedFifoBuffer
Buffer
PriorityQueue
SynchronizedPriorityQueue UnboundedFifoBuffer
New collection interface that specifies a removal order for the collection, used to implement queues and queue-like things.
Bag Interface and Implementations Bag
DefaultMapBag
HashBag
SortedBag
TreeBag
New collections interface that keeps a count of its members.
Utilities BagUtils
BufferUtils
CollectionUtils
ComparatorUtils
ListUtils
MapUtils
SetUtils
Manipulate collection objects, determine set theoretic properties, ensure type-safety, provide decorators, etc.
Functor Interfaces Factory
Predicate
Closure
Transformer
Create views or functors on a collection. If your collection represents X, these allow you to define and look at f(X).
Miscellaneous StringStack
DefaultMapEntry
A stack of strings; and the trivial implementation of Map.Entry.


Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.