Top Description Interfaces Classes
[default module]

Package org.apache.commons.collections4


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

The following collection implementations are provided in the package:

Interface Summary

Modifier and TypeInterface and Description
public interface
Bag<
the type of elements in this bag
E
>

Defines a collection that counts the number of times an object appears in the collection.

public interface
BidiMap<
the type of the keys in the map
K
,
the type of the values in the map
V
>

Defines a map that allows bidirectional lookup between key and values.

public interface
BoundedCollection<
the type of elements in this collection
E
>

Defines a collection that is bounded in size.

public interface
BoundedMap<
the type of the keys in this map
K
,
the type of the values in this map
V
>

Defines a map that is bounded in size.

public interface
Closure<
the type that the closure acts on
T
>

Defines a functor interface implemented by classes that do something.

public interface
Equator<
the types of object this Equator can evaluate.
T
>

An equation function, which determines equality between objects of type T.

public interface
Factory<
the type that the factory creates
T
>

Defines a functor interface implemented by classes that create objects.

public interface
Get<
the type of the keys in this map
K
,
the type of the values in this map
V
>

The "read" subset of the java.util.Map interface.

public interface
IterableGet<
the type of the keys in this map
K
,
the type of the values in this map
V
>

The "read" subset of the java.util.Map interface.

public interface
IterableMap<
the type of the keys in this map
K
,
the type of the values in this map
V
>

Defines a map that can be iterated directly without needing to create an entry set.

public interface
IterableSortedMap<
the type of the keys in the map
K
,
the type of the values in the map
V
>

SortedMap + OrderedMap.

public interface
KeyValue<
the type of the key
K
,
the type of the value
V
>

Defines a simple key value pair.

public interface
ListValuedMap<
the type of the keys in this map
K
,
the type of the values in this map
V
>

Defines a map that holds a list of values against each key.

public interface
MapIterator<
the type of the keys in the map
K
,
the type of the values in the map
V
>

Defines an iterator that operates over a Map.

public interface
MultiMap<
the type of the keys in this map
K
,
the type of the values in this map
V
>

Deprecated since 4.1, use MultiValuedMap instead
Defines a map that holds a collection of values against each key.
public interface
MultiSet<
the type held in the multiset
E
>

Defines a collection that counts the number of times an object appears in the collection.

public interface
MultiValuedMap<
the type of the keys in this map
K
,
the type of the values in this map
V
>

Defines a map that holds a collection of values against each key.

public interface
OrderedBidiMap<
the type of the keys in the map
K
,
the type of the values in the map
V
>

Defines a map that allows bidirectional lookup between key and values and retains and provides access to an ordering.

public interface
OrderedIterator<
the type of elements returned by this iterator
E
>

Defines an iterator that operates over an ordered container.

public interface
OrderedMap<
the type of the keys in the map
K
,
the type of the values in the map
V
>

Defines a map that maintains order and allows both forward and backward iteration through that order.

public interface
OrderedMapIterator<
the type of the keys in the map
K
,
the type of the values in the map
V
>

Defines an iterator that operates over an ordered Map.

public interface
Predicate<
the type that the predicate queries
T
>

Defines a functor interface implemented by classes that perform a predicate test on an object.

public interface
Put<
the type of the keys in this map
K
,
the type of the values in this map
V
>

The "write" subset of the Map interface.

public interface
ResettableIterator<
the type of elements returned by this iterator
E
>

Defines an iterator that can be reset back to an initial state.

public interface
ResettableListIterator<
the type of elements returned by this iterator
E
>

Defines a list iterator that can be reset back to an initial state.

public interface
SetValuedMap<
the type of the keys in this map
K
,
the type of the values in this map
V
>

Defines a map that holds a set of values against each key.

public interface
SortedBag<
the type of elements in this bag
E
>

Defines a type of Bag that maintains a sorted order among its unique representative members.

public interface
SortedBidiMap<
the type of the keys in the map
K
,
the type of the values in the map
V
>

Defines a map that allows bidirectional lookup between key and values and retains both keys and values in sorted order.

public interface
Transformer<
the input type to the transformer
I
,
the output type from the transformer
O
>

Defines a functor interface implemented by classes that transform one object into another.

public interface
Trie<
the type of the keys in this map
K
,
the type of the values in this map
V
>

Defines the interface for a prefix tree, an ordered tree data structure.

public interface
Unmodifiable

Marker interface for collections, maps and iterators that are unmodifiable.

Class Summary

Modifier and TypeClass and Description
public class
ArrayStack<
the type of elements in this list
E
>

Deprecated use java.util.ArrayDeque instead (available from Java 1.6)
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.
pack-priv class
ArrayUtils

Operations on arrays, primitive arrays (like int[]) and primitive wrapper arrays (like Integer[]).

public class
BagUtils

Provides utility methods and decorators for Bag and SortedBag instances.

public class
ClosureUtils

ClosureUtils provides reference implementations and utilities for the Closure functor interface.

public class
CollectionUtils

Provides utility methods and decorators for Collection instances.

public class
ComparatorUtils

Provides convenient static utility methods for Comparator objects.

public class
EnumerationUtils

Provides utility methods for Enumeration instances.

public class
FactoryUtils

FactoryUtils provides reference implementations and utilities for the Factory functor interface.

public class
FluentIterable<
the element type
E
>

A FluentIterable provides a powerful yet simple API for manipulating Iterable instances in a fluent manner.

public class
FunctorException

Runtime exception thrown from functors.

public class
IterableUtils

Provides utility methods and decorators for Iterable instances.

public class
IteratorUtils

Provides static utility methods and decorators for Iterator instances.

public class
ListUtils

Provides utility methods and decorators for List instances.

public class
MapUtils

Provides utility methods and decorators for Map and SortedMap instances.

public class
MultiMapUtils

Provides utility methods and decorators for MultiValuedMap instances.

public class
MultiSetUtils

Provides utility methods and decorators for MultiSet instances.

public class
PredicateUtils

PredicateUtils provides reference implementations and utilities for the Predicate functor interface.

public class
QueueUtils

Provides utility methods and decorators for Queue instances.

public class
SetUtils

Provides utility methods and decorators for Set and SortedSet instances.

public class
SplitMapUtils

Utilities for working with "split maps:" objects that implement Put and/or Get but not Map.

public class
TransformerUtils

TransformerUtils provides reference implementations and utilities for the Transformer functor interface.

public class
TrieUtils

A collection of Trie utilities.