com.phloc.commons.collections.triple

Class Triple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

java.lang.Object

com.phloc.commons.collections.triple.Triple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

Type Parameters:

DATA1TYPE - First type.

DATA2TYPE - Second type.

DATA3TYPE - Third type.

All Implemented Interfaces:

IReadonlyTriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>, ITriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

@Immutable
public final class Triple<DATA1TYPE,DATA2TYPE,DATA3TYPE>
extends Object
implements ITriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

A generic writable triple class. It wraps three objects of arbitrary type. If you only want two objects, look at the class Pair. If you just want to wrap a single object, look at class Wrapper.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
Triple(IReadonlyTriple<? extends DATA1TYPE,? extends DATA2TYPE,? extends DATA3TYPE> rhs)
Triple(T2 aFirst, U2 aSecond, V2 aThird)

Method Summary

Methods

Modifier and Type	Method and Description
static <T,U,V> ITriple<T,U,V>	create(T aFirst, U aSecond, V aThird)
boolean	equals(Object o)
DATA1TYPE	getFirst()
DATA2TYPE	getSecond()
DATA3TYPE	getThird()
int	hashCode()
EChange	setFirst(DATA1TYPE aFirst) Set the first value.
EChange	setSecond(DATA2TYPE aSecond) Set the second value.
EChange	setThird(DATA3TYPE aThird) Set the third value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Triple

public Triple(@Nullable
      T2 aFirst,
      @Nullable
      U2 aSecond,
      @Nullable
      V2 aThird)

Triple

public Triple(@Nonnull
      IReadonlyTriple<? extends DATA1TYPE,? extends DATA2TYPE,? extends DATA3TYPE> rhs)

Method Detail

getFirst

@Nullable
public DATA1TYPE getFirst()

Specified by:

getFirst in interface IReadonlyTriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

Returns:

The first element. May be null.

setFirst

@Nonnull
public EChange setFirst(@Nullable
                       DATA1TYPE aFirst)

Description copied from interface: ITriple

Set the first value.

Specified by:

setFirst in interface ITriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

Parameters:

aFirst - The first value. May be null.

Returns:

EChange

getSecond

@Nullable
public DATA2TYPE getSecond()

Specified by:

getSecond in interface IReadonlyTriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

Returns:

The second element. May be null.

setSecond

@Nonnull
public EChange setSecond(@Nullable
                        DATA2TYPE aSecond)

Description copied from interface: ITriple

Set the second value.

Specified by:

setSecond in interface ITriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

Parameters:

aSecond - The second value. May be null.

Returns:

EChange

getThird

@Nullable
public DATA3TYPE getThird()

Specified by:

getThird in interface IReadonlyTriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

Returns:

The third element. May be null.

setThird

@Nonnull
public EChange setThird(@Nullable
                       DATA3TYPE aThird)

Description copied from interface: ITriple

Set the third value.

Specified by:

setThird in interface ITriple<DATA1TYPE,DATA2TYPE,DATA3TYPE>

Parameters:

aThird - The third value. May be null.

Returns:

EChange

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static <T,U,V> ITriple<T,U,V> create(@Nullable
                                    T aFirst,
                                    @Nullable
                                    U aSecond,
                                    @Nullable
                                    V aThird)