de.scravy.pair

Interface Pair<First,Second>

Type Parameters:

First - The type of the first (left) component.

Second - The type of the second (right) component.

All Known Subinterfaces:

ComparablePair<First,Second>, ComparableSerializablePair<First,Second>, SerializablePair<First,Second>

public interface Pair<First,Second>

A pair consisting of a first (left) and a second (right) component. Classes implementing this interface must be final (i.e. are not allowed to have subclasses) and should contain exactly two things: A first component and a second component (because that is what a pair is: A first and a second component, and not a first and a second component and then some).

Since:

1.0.0

Author:

Julian Fleischer

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) equals for Pairs works almost the same as for objects, minus checking for whether the other object is of the same class.
First	getFirst() Get the first (left) component of this pair.
Second	getSecond() Get the second (right) component of this pair.

Method Detail

getFirst

First getFirst()

Get the first (left) component of this pair.

Returns:

The first component. This may include null in general.

getSecond

Second getSecond()

Get the second (right) component of this pair.

Returns:

The second component. This may include null in general.

equals

boolean equals(Object other)

equals for Pairs works almost the same as for objects, minus checking for whether the other object is of the same class. Since all pairs are final and immutable, equals is still an equivalence relation and all pairs (no matter what exact type) are considered equal. Pairs behave like that since version 1.1.0 (unfortunately it was not yet considered in version 1.0.0).

Overrides:

equals in class Object

Returns:

Whether this pairs components equal the components of the other pair.

Since:

1.1.0