com.phloc.commons.collections.pair

Class ReadonlyPair<DATA1TYPE,DATA2TYPE>

java.lang.Object

com.phloc.commons.collections.pair.ReadonlyPair<DATA1TYPE,DATA2TYPE>

Type Parameters:

DATA1TYPE - First type.

DATA2TYPE - Second type.

All Implemented Interfaces:

IReadonlyPair<DATA1TYPE,DATA2TYPE>

@Immutable
public final class ReadonlyPair<DATA1TYPE,DATA2TYPE>
extends Object
implements IReadonlyPair<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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static <T,U> IReadonlyPair<T,U>	create(T aFirst, U aSecond)
boolean	equals(Object o)
DATA1TYPE	getFirst()
DATA2TYPE	getSecond()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadonlyPair

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

ReadonlyPair

public ReadonlyPair(@Nonnull
            IReadonlyPair<? extends DATA1TYPE,? extends DATA2TYPE> rhs)

Method Detail

getFirst

@Nullable
public DATA1TYPE getFirst()

Specified by:

getFirst in interface IReadonlyPair<DATA1TYPE,DATA2TYPE>

Returns:

The first element. May be null.

getSecond

@Nullable
public DATA2TYPE getSecond()

Specified by:

getSecond in interface IReadonlyPair<DATA1TYPE,DATA2TYPE>

Returns:

The second element. May be null.

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