@Revision(value="$Revision: 1.8 $", date="$Date: 2006/11/09 02:10:09 $", tag="$Name: $")

Package rcf.core.util.groups

TODO: Javadoc Includes the Pair and Triple objects, which are essentially fixed-length type-parameterized ADTs.

See:
Description

Interface Summary

ImmutablePairInterface<A,B>	TODO: Javadoc Contains methods for accessing the first and second elements in a pair object, which can be virtualized.
ImmutableSingletonInterface<A>	TODO: Javadoc Contains methods for accessing a reference stored in a singleton object, which can be virtualized.
ImmutableTripleInterface<A,B,C>	TODO: Javadoc Contains methods for accessing the first, second and third elements in a triple object, which can be virtualized.
PairInterface<A,B>	TODO: Javadoc Contains methods for mutating the first and second elements in a pair object, which can be virtualized.
SingletonInterface<A>	TODO: Javadoc Contains methods for mutating the content element in a singleton object, which can be virtualized.
TripleInterface<A,B,C>	TODO: Javadoc Contains methods for mutating the first, second and third elements in a pair object, which can be virtualized.

Class Summary

ImmutablePair<A,B>	TODO: Javadoc Provides a simple, type safe (generic) wrapper which can encapsulate a pair of references.
ImmutablePair.Accessor<A,B>	TODO: Javadoc Binds a pair of accessors to form a pair accessor.
ImmutablePair.Iterable<A,B>	TODO: Javadoc Binds a pair of immutable iterable objects, allowing them to be iterated in tandem.
ImmutablePair.Iterator<A,B>	TODO: Javadoc Binds a pair of immutable iterators, allowing them to be iterated in tandem.
ImmutablePairAAdapter<A,B>	TODO: Javadoc Designed to adapt from the first field of a pair to a complete pair.
ImmutablePairBAdapter<A,B>	TODO: Javadoc Designed to adapt from the first field of a pair to a complete pair.
ImmutablePairSwapAdapter<A,B>	TODO: Javadoc
ImmutableSingleton<A>	TODO: Javadoc Provides a simple, type safe (generic) wrapper which can encapsulate a single reference.
ImmutableSingleton.Accessor<A>	TODO: Javadoc Wrap an accessor to form an accessor which will operate over singletons.
ImmutableSingleton.Iterable<A>	TODO: Javadoc Wrap a single immutable iterable collection, create an immutable iterable over singletons of elements.
ImmutableSingleton.Iterator<A>	TODO: Javadoc Wrap a single immutable iterator, create an immutable iterator over singletons of elements.
ImmutableSingletonAAdapter<A>	TODO: Javadoc Designed to adapt from the payload of a singleton to a complete singleton.
ImmutableTriple<A,B,C>	TODO: Javadoc Provides a simple, type safe (generic) wrapper which can encapsulate a triple of references.
ImmutableTriple.Accessor<A,B,C>	TODO: Javadoc Binds a triple of accessors to form a triple accessor.
ImmutableTriple.Iterable<A,B,C>	TODO: Javadoc Binds a triple of immutable iterable objects, allowing them to be iterated simultaneously.
ImmutableTriple.Iterator<A,B,C>	TODO: Javadoc Binds a triple of immutable iterators, allowing them to be iterated simultaneously.
Pair<A,B>	TODO: Javadoc Provides a simple, type safe (generic) wrapper which can encapsulate a pair of references.
Pair.Iterable<A,B>	TODO: Javadoc Binds a pair of iterable objects, allowing them to be iterated in tandem.
Pair.Iterator<A,B>	TODO: Javadoc Binds a pair of iterators, allowing them to be iterated in tandem.
PairAAdapter<A,B>	TODO: Javadoc Designed to adapt from the first field of a pair to a complete pair.
PairBAdapter<A,B>	TODO: Javadoc Designed to adapt from the first field of a pair to a complete pair.
PairSwapAdapter<A,B>	TODO: Javadoc
Singleton<A>	TODO: Javadoc Provides a simple, type safe (generic) wrapper which can encapsulate a single reference.
Singleton.Iterable<A>	TODO: Javadoc Wrap a single iterable collection, create an iterable over singletons of elements.
Singleton.Iterator<A>	TODO: Javadoc Wrap a single iterator, create an iterator over singletons of elements.
SingletonAAdapter<A>	TODO: Javadoc Designed to adapt from the payload of a singleton to a complete singleton.
Triple<A,B,C>	TODO: Javadoc Provides a simple, type safe (generic) wrapper which can encapsulate a triple of references.
Triple.Iterable<A,B,C>	TODO: Javadoc Binds a triple of iterable objects, allowing them to be iterated simultaneously.
Triple.Iterator<A,B,C>	TODO: Javadoc Binds a triple of iterators, allowing them to be iterated simultaneously.

Package rcf.core.util.groups Description

TODO: Javadoc Includes the Pair and Triple objects, which are essentially fixed-length type-parameterized ADTs. This package also includes generalized interfaces and immutable versions of these classes. Finally, there are a number of inner classes for aggregating objects of standard types into pairs and triples.

In addition, this package contains a number of type adapters which support the adaptation of an object to a grouping (Pair or Singleton) of objects. These adapters such as ImmutablePairAAdapter also make use of optional inner type adapters to create a pair from an object and an attribute of that object, by using the ImmutablePairAAdapter in conjunction with an adapter which retrieves the appropriate attribute from the object.

TODO: Javadoc review, Seal/Finalize

Author:

Greg Gibeling