com.helger.commons.collection.pair

Class Pair<DATA1TYPE,DATA2TYPE>

java.lang.Object

com.helger.commons.collection.pair.Pair<DATA1TYPE,DATA2TYPE>

Type Parameters:

DATA1TYPE - First type.

DATA2TYPE - Second type.

All Implemented Interfaces:

IMutablePair<DATA1TYPE,DATA2TYPE>, IPair<DATA1TYPE,DATA2TYPE>, ICloneable<Pair<DATA1TYPE,DATA2TYPE>>, Serializable

@NotThreadSafe
public final class Pair<DATA1TYPE,DATA2TYPE>
extends Object
implements IMutablePair<DATA1TYPE,DATA2TYPE>, ICloneable<Pair<DATA1TYPE,DATA2TYPE>>

A generic pair class. It wraps two objects of arbitrary type. If you just want to wrap a single object, look at class Wrapper.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pair()
Pair(IPair<? extends DATA1TYPE,? extends DATA2TYPE> rhs)
Pair(T2 aFirst, U2 aSecond)

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.pair.IPair

getComparatorFirst, getComparatorSecond

Constructor Detail

Pair

public Pair()

Pair

public Pair(@Nullable
            T2 aFirst,
            @Nullable
            U2 aSecond)

Pair

public Pair(@Nonnull
            IPair<? extends DATA1TYPE,? extends DATA2TYPE> rhs)

Method Detail

getFirst

@Nullable
public DATA1TYPE getFirst()

Specified by:

getFirst in interface IPair<DATA1TYPE,DATA2TYPE>

Returns:

The first element. May be null depending on the implementation.

setFirst

@Nonnull
public EChange setFirst(@Nullable
                                  DATA1TYPE aFirst)

Description copied from interface: IMutablePair

Set the first value.

Specified by:

setFirst in interface IMutablePair<DATA1TYPE,DATA2TYPE>

Parameters:

aFirst - The first value. May be null depending on the implementation.

Returns:

EChange

getSecond

@Nullable
public DATA2TYPE getSecond()

Specified by:

getSecond in interface IPair<DATA1TYPE,DATA2TYPE>

Returns:

The second element. May be null depending on the implementation.

setSecond

@Nonnull
public EChange setSecond(@Nullable
                                   DATA2TYPE aSecond)

Description copied from interface: IMutablePair

Set the second value.

Specified by:

setSecond in interface IMutablePair<DATA1TYPE,DATA2TYPE>

Parameters:

aSecond - The second value. May be null depending on the implementation.

Returns:

EChange

getClone

@Nonnull
public Pair<DATA1TYPE,DATA2TYPE> getClone()

Specified by:

getClone in interface ICloneable<Pair<DATA1TYPE,DATA2TYPE>>

Returns:

A 100% deep-copy of the implementing class.

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> Pair<T,U> create(@Nullable
                                               T aFirst,
                                               @Nullable
                                               U aSecond)