Module dk.cloudcreate.essentials.shared

Package dk.cloudcreate.essentials.shared.functional.tuple.comparable

Class ComparablePair<T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>>

java.lang.Object

dk.cloudcreate.essentials.shared.functional.tuple.comparable.ComparablePair<T1,T2>

Type Parameters:

T1 - the first element type

T2 - the second element type

All Implemented Interfaces:

ComparableTuple<ComparablePair<T1,T2>>, Serializable, Comparable<ComparablePair<T1,T2>>

public class ComparablePair<T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>>
extends Object
implements ComparableTuple<ComparablePair<T1,T2>>

Represents a ComparableTuple with two elements.
Note: ComparablePair supports equals(Object) comparison using subclasses, e.g.:

     public class LeftAndRightSide extends ComparablePair<String, String> {

         public LeftAndRightSide(String leftSide, String rightSide) {
             super(leftSide, rightSide);
         }
     }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
T1	_1	The first element in this tuple
T2	_2	The second element in this tuple

Constructor Summary

Constructors

Constructor	Description
ComparablePair(T1 t1, T2 t2)	Construct a new ComparableTuple with 2 elements

Method Summary

Modifier and Type	Method	Description
T1	_1()	The first element in this tuple
T2	_2()	The second element in this tuple
int	arity()	Number of arguments/elements in the Tuple
int	compareTo(ComparablePair<T1,T2> o)
boolean	equals(Object o)
int	hashCode()
<R1 extends Comparable<? super R1>,R2 extends Comparable<? super R2>> ComparablePair<R1,R2>	map(BiFunction<? super T1,? super T2,ComparablePair<R1,R2>> mappingFunction)	Maps the elements of this ComparablePair using the mapping function
<R1 extends Comparable<? super R1>,R2 extends Comparable<? super R2>> ComparablePair<R1,R2>	map(Function<? super T1,? super R1> mappingFunction1, Function<? super T2,? super R2> mappingFunction2)	Maps the elements of this ComparablePair using two distinct mapping functions
<R1 extends Comparable<? super R1>> ComparablePair<R1,T2>	map1(Function<? super T1,? super R1> mappingFunction1)	Map the first element of this ComparablePair using the mapping function
<R2 extends Comparable<? super R2>> ComparablePair<T1,R2>	map2(Function<? super T2,? super R2> mappingFunction2)	Map the second element of this ComparablePair using the mapping function
ComparablePair<T2,T1>	swap()	Swap the elements of this ComparablePair
Map.Entry<T1,T2>	toEntry()	Converts the ComparablePair to a Map Map.Entry
List<?>	toList()	Convert the Tuple to a list
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_1

public final T1 extends Comparable<? super T1> _1

The first element in this tuple

_2

public final T2 extends Comparable<? super T2> _2

The second element in this tuple

Constructor Detail

ComparablePair

public ComparablePair(T1 t1,
                      T2 t2)

Construct a new ComparableTuple with 2 elements

Parameters:

t1 - the first element

t2 - the second element

Method Detail

arity

public int arity()

Description copied from interface: ComparableTuple

Number of arguments/elements in the Tuple

Specified by:

arity in interface ComparableTuple<T1 extends Comparable<? super T1>>

Returns:

Number of arguments/elements in the Tuple

toList

public List<?> toList()

Description copied from interface: ComparableTuple

Convert the Tuple to a list

Specified by:

toList in interface ComparableTuple<T1 extends Comparable<? super T1>>

Returns:

list of all Tuple elements

_1

public T1 _1()

The first element in this tuple

Returns:

The first element in this tuple

_2

public T2 _2()

The second element in this tuple

Returns:

The second element in this tuple

swap

public ComparablePair<T2,T1> swap()

Swap the elements of this ComparablePair

Returns:

A new ComparablePair where the first element is the second element of this ComparablePair AND where the second element is the first element of this ComparablePair

toEntry

public Map.Entry<T1,T2> toEntry()

Converts the ComparablePair to a Map Map.Entry

Returns:

a Map.Entry where the key is the first element of this ComparablePair and the value is the second element of this ComparablePair

compareTo

public int compareTo(ComparablePair<T1,T2> o)

Specified by:

compareTo in interface Comparable<T1 extends Comparable<? super T1>>

map

public <R1 extends Comparable<? super R1>,R2 extends Comparable<? super R2>> ComparablePair<R1,R2> map(BiFunction<? super T1,? super T2,ComparablePair<R1,R2>> mappingFunction)

Maps the elements of this ComparablePair using the mapping function

Type Parameters:

R1 - result type for first element of the ComparablePair after applying the mapping function

R2 - result type for second element of the ComparablePair after applying the mapping function

Parameters:

mappingFunction - the mapping function

Returns:

a new ComparablePair with the result of applying the mapping function to this ComparablePair

map

public <R1 extends Comparable<? super R1>,R2 extends Comparable<? super R2>> ComparablePair<R1,R2> map(Function<? super T1,? super R1> mappingFunction1,
                                                                                                                   Function<? super T2,? super R2> mappingFunction2)

Maps the elements of this ComparablePair using two distinct mapping functions

Type Parameters:

R1 - result type for first element of the ComparablePair after applying the mapping function

R2 - result type for second element of the ComparablePair after applying the mapping function

Parameters:

mappingFunction1 - the mapping function for element number 1

mappingFunction2 - the mapping function for element number 2

Returns:

a new ComparablePair with the result of applying the mapping function to this ComparablePair

map1

public <R1 extends Comparable<? super R1>> ComparablePair<R1,T2> map1(Function<? super T1,? super R1> mappingFunction1)

Map the first element of this ComparablePair using the mapping function

Type Parameters:

R1 - result type for first element of the ComparablePair after applying the mapping function

Parameters:

mappingFunction1 - the mapping function for element number 1

Returns:

a new ComparablePair with the result of applying the mapping function to the first element of this ComparablePair

map2

public <R2 extends Comparable<? super R2>> ComparablePair<T1,R2> map2(Function<? super T2,? super R2> mappingFunction2)

Map the second element of this ComparablePair using the mapping function

Type Parameters:

R2 - result type for second element of the ComparablePair after applying the mapping function

Parameters:

mappingFunction2 - the mapping function for element number 2

Returns:

a new ComparablePair with the result of applying the mapping function to the second element of this ComparablePair

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