com.phoenixst.collections (Plexus v0.13.1 API Specification)

Package com.phoenixst.collections

This package contains additions and/or fixes to the Jakarta-Commons Collections package.

Interface Summary
InvertibleTransformer	An invertible `Transformer`.
Reapable	Something which can be reaped; see Reaper for more information.
Reaper	The interface defining an object which reaps `Reapables`.

Interface Summary

InvertibleTransformer

An invertible Transformer.

Reapable

Something which can be reaped; see Reaper for more information.

Reaper

The interface defining an object which reaps


  Reapables

Class Summary
AbstractSingletonCollection	A modifiable, lazy singleton `Collection` view.
AbstractUnmodifiableCollection	An extension of AbstractCollection in which all modifying operations explicitly throw exceptions.
AllPredicate	A `Predicate` which returns the logical short-circuit and of its operands.
AndPredicate	A `Predicate` which returns the logical short-circuit and of its operands.
AnyPredicate	A `Predicate` which returns the logical short-circuit or of its operands.
CartesianProduct	A `Collection` whose elements are all of the ordered pairs (x, y), where x is from the first delegate collection and y is from the second.
ClosureChain	A chain of `Closures`.
CollectionWrapper	A `Collection` which wraps another.
CompositeCollection	A `Collection` view of a number of other `Collections`.
ContainsPredicate	A `Predicate` which tests whether an object is an element of a `Collection`.
EqualPredicate	A `Predicate` which simply tests the `evaluate( object )` argument for equality with a specified object.
FalsePredicate	A `Predicate` which always returns `false`.
FilteredCollection	A `Collection` which presents a filtered view of another.
FilteredIterator	A filtered `Iterator`.
Identifier	Basically, this is just an `Object` with a Identifier value set by the constructor.
IdentityPredicate	A `Predicate` which simply tests the `evaluate( object )` argument for reference equality with a specified object.
InstanceofPredicate	A `Predicate` which tests the `evaluate( object )` argument for being an instance of a particular class.
IteratorChain	A chain of `Iterators`.
LoggingCollection	A `Collection` which wraps another to provide logging support.
LoggingIterator	An `Iterator` which wraps another to provide logging support.
NotPredicate	A `Predicate` which returns the logical converse of its operand.
OrderedPair	A simple mutable ordered pair implementation.
OrPredicate	A `Predicate` which returns the logical short-circuit or of its operands.
PredicateUtils	This class contains static members related to `Predicates`.
ReapableCollection	A reapable `Collection`.
RunnableReaper	A `Runnable` which reaps `Reapables`.
SimpleStack	A simple stack data structure, basically a convenience extension of `ArrayList`.
SynchronizedCollection	A synchronized view of another `Collection`.
TransformerChain	A chain of `Transformers`.
TruePredicate	A `Predicate` which always returns `true`.
UnmodifiableIterator	An unmodifiable view of an `Iterator`.
UnorderedPair	A simple mutable unordered pair implementation.

Class Summary

AbstractSingletonCollection

A modifiable, lazy singleton Collection view.

AbstractUnmodifiableCollection

An extension of AbstractCollection in which all modifying operations explicitly throw exceptions.

AllPredicate

A Predicate which returns the logical short-circuit and of its operands.

AndPredicate

A Predicate which returns the logical short-circuit and of its operands.

AnyPredicate

A Predicate which returns the logical short-circuit or of its operands.

CartesianProduct

A Collection whose elements are all of the ordered pairs (x, y), where x is from the first delegate collection and y is from the second.

ClosureChain

A chain of Closures.

CollectionWrapper

A Collection which wraps another.

CompositeCollection

A Collection view of a number of other Collections.

ContainsPredicate

A Predicate which tests whether an object is an element of a Collection.

EqualPredicate

A Predicate which simply tests the evaluate( object ) argument for equality with a specified object.

FalsePredicate

A Predicate which always returns false.

FilteredCollection

A Collection which presents a filtered view of another.

FilteredIterator

A filtered Iterator.

Identifier

Basically, this is just an Object with a Identifier value set by the constructor.

IdentityPredicate

A Predicate which simply tests the evaluate( object ) argument for reference equality with a specified object.

InstanceofPredicate

A Predicate which tests the evaluate( object ) argument for being an instance of a particular class.

IteratorChain

A chain of Iterators.

LoggingCollection

A Collection which wraps another to provide logging support.

LoggingIterator

An Iterator which wraps another to provide logging support.

NotPredicate

A Predicate which returns the logical converse of its operand.

OrderedPair

A simple mutable ordered pair implementation.

OrPredicate

A Predicate which returns the logical short-circuit or of its operands.

PredicateUtils

This class contains static members related to Predicates.

ReapableCollection

A reapable Collection.

RunnableReaper

A Runnable which reaps Reapables.

SimpleStack

A simple stack data structure, basically a convenience extension of ArrayList.

SynchronizedCollection

A synchronized view of another Collection.

TransformerChain

A chain of Transformers.

TruePredicate

A Predicate which always returns true.

UnmodifiableIterator

An unmodifiable view of an Iterator.

UnorderedPair

A simple mutable unordered pair implementation.

Package com.phoenixst.collections Description:

This package contains additions and/or fixes to the Jakarta-Commons Collections package. Much of the functionality here has been made obsolete by the release of version 3.1 of that package, but I can't upgrade the Plexus Graph Library until other unrelated products have also been upgraded (Plexus is currently in production use and must integrate well with the versions of JBoss, struts, etc. that are being used there).

Since: Plexus 1.0

Version: 1.0

Author: Ray A. Conner