com.helger.commons.collection.pair

Class ReadOnlyPair<DATA1TYPE,DATA2TYPE>

java.lang.Object

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

Type Parameters:

DATA1TYPE - First type.

DATA2TYPE - Second type.

All Implemented Interfaces:

IPair<DATA1TYPE,DATA2TYPE>, Serializable

@Immutable
public final class ReadOnlyPair<DATA1TYPE,DATA2TYPE>
extends Object
implements IPair<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
ReadOnlyPair(IPair<? extends DATA1TYPE,? extends DATA2TYPE> rhs)
ReadOnlyPair(T2 aFirst, U2 aSecond)

Method Summary

Modifier and Type	Method and Description
static <T,U> ReadOnlyPair<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

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

getComparatorFirst, getComparatorSecond

Constructor Detail

ReadOnlyPair

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

ReadOnlyPair

public ReadOnlyPair(@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.

getSecond

@Nullable
public DATA2TYPE getSecond()

Specified by:

getSecond in interface IPair<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> ReadOnlyPair<T,U> create(@Nullable
                                                       T aFirst,
                                                       @Nullable
                                                       U aSecond)