rcf.core.util.groups
Class ImmutableTriple<A,B,C>

java.lang.Object
  rcf.core.util.groups.ImmutableSingleton<A>
      rcf.core.util.groups.ImmutablePair<A,B>
          rcf.core.util.groups.ImmutableTriple<A,B,C>

Type Parameters:

A - The type of the first entry in each triple.

B - The type of the second entry in each triple.

C - The type of the third entry in each triple.

All Implemented Interfaces:

ImmutablePairInterface<A,B>, ImmutableSingletonInterface<A>, ImmutableTripleInterface<A,B,C>

Direct Known Subclasses:

ImmutableTriple.Accessor, ImmutableTriple.Iterable, Triple.Iterable

@Revision(value="$Revision: 1.29 $",
          date="$Date: 2006/11/14 15:47:41 $",
          tag="$Name:  $")
public class ImmutableTriple<A,B,C>
extends ImmutablePair<A,B>
implements ImmutableTripleInterface<A,B,C>

TODO: Javadoc Provides a simple, type safe (generic) wrapper which can encapsulate a triple of references. This is effectively a multi-type, type safe limited length array.

Version:

$Revision: 1.29 $

Author:

Greg Gibeling

Nested Class Summary

static class	ImmutableTriple.Accessor<A,B,C> TODO: Javadoc Binds a triple of accessors to form a triple accessor.
static class	ImmutableTriple.Iterable<A,B,C> TODO: Javadoc Binds a triple of immutable iterable objects, allowing them to be iterated simultaneously.
static class	ImmutableTriple.Iterator<A,B,C> TODO: Javadoc Binds a triple of immutable iterators, allowing them to be iterated simultaneously.

Field Summary

protected C

c TODO: Javadoc The third object to store.

Fields inherited from class rcf.core.util.groups.ImmutablePair

b

Fields inherited from class rcf.core.util.groups.ImmutableSingleton

a

Constructor Summary

ImmutableTriple(A _a, B _b, C _c)
TODO: Javadoc Base constructor, simply records the elements for this object.

Method Summary

boolean	equals(Object o)
C	getC() TODO: Javadoc Get the third element of this triple.
int	hashCode()
String	toString()

Methods inherited from class rcf.core.util.groups.ImmutablePair

getA, getB

Methods inherited from class rcf.core.util.groups.ImmutableSingleton

get

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rcf.core.util.groups.ImmutableTripleInterface

getA, getB

Methods inherited from interface rcf.core.util.groups.ImmutableSingletonInterface

get

Field Detail

c

protected final C c

TODO: Javadoc The third object to store.

Constructor Detail

ImmutableTriple

public ImmutableTriple(A _a,
                       B _b,
                       C _c)

TODO: Javadoc Base constructor, simply records the elements for this object.

Parameters:

_a - The first object to store.

_b - The second object to store.

_c - The third object to store.

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class ImmutablePair<A,B>

getC

public C getC()

Description copied from interface: ImmutableTripleInterface

TODO: Javadoc Get the third element of this triple.

Specified by:

getC in interface ImmutableTripleInterface<A,B,C>

Returns:

The third element of this triple.

hashCode

public int hashCode()

Overrides:

hashCode in class ImmutablePair<A,B>

toString

public String toString()

Overrides:

toString in class ImmutablePair<A,B>