Module dk.cloudcreate.essentials.shared

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

Interface ComparableTuple<CONCRETE_TUPLE extends ComparableTuple<CONCRETE_TUPLE>>

Type Parameters:

CONCRETE_TUPLE - the concrete ComparableTuple sub-type

All Superinterfaces:

Comparable<CONCRETE_TUPLE>, Serializable

All Known Implementing Classes:

ComparableEmpty, ComparablePair, ComparableSingle, ComparableTriple

public interface ComparableTuple<CONCRETE_TUPLE extends ComparableTuple<CONCRETE_TUPLE>>
extends Comparable<CONCRETE_TUPLE>, Serializable

Base interface for all ComparableTuple's.
A ComparableTuple is an immutable object that can contain the following (supported) number of elements:

Number of element in Tuple	Concrete ComparableTuple type	Factory method
0	ComparableEmpty	empty()
1	ComparableSingle	of(Comparable)
2	ComparablePair	of(Comparable, Comparable)
3	ComparableTriple	of(Comparable, Comparable, Comparable)

Note: ComparableTuple (and its subclasses) supports Object.equals(Object) comparison using subclasses for the different subclasses

Method Summary

Modifier and Type	Method	Description
int	arity()	Number of arguments/elements in the Tuple
static ComparableEmpty	empty()	Create/Get and ComparableEmpty ComparableTuple
static <T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>> ComparablePair<T1,T2>	fromEntry(Map.Entry<? extends T1,? extends T2> entry)	Create a new ComparableTuple with 2 elements from a Map Map.Entry
static ComparableEmpty	of()	Create/Get and ComparableEmpty Tuple
static <T1 extends Comparable<? super T1>> ComparableSingle<T1>	of(T1 t1)	Create a new ComparableTuple with 1 element
static <T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>> ComparablePair<T1,T2>	of(T1 t1, T2 t2)	Create a new ComparableTuple with 2 elements
static <T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>,T3 extends Comparable<? super T3>> ComparableTriple<T1,T2,T3>	of(T1 t1, T2 t2, T3 t3)	Create a new ComparableTuple with 3 elements
List<?>	toList()	Convert the Tuple to a list

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

arity

int arity()

Number of arguments/elements in the Tuple

Returns:

Number of arguments/elements in the Tuple

toList

List<?> toList()

Convert the Tuple to a list

Returns:

list of all Tuple elements

empty

static ComparableEmpty empty()

Create/Get and ComparableEmpty ComparableTuple

Returns:

an ComparableEmpty Tuple

of

static ComparableEmpty of()

Create/Get and ComparableEmpty Tuple

Returns:

an ComparableEmpty Tuple

of

static <T1 extends Comparable<? super T1>> ComparableSingle<T1> of(T1 t1)

Create a new ComparableTuple with 1 element

Type Parameters:

T1 - the first element type

Parameters:

t1 - the first element

Returns:

the newly created ComparableSingle tuple

of

static <T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>> ComparablePair<T1,T2> of(T1 t1,
                                                                                                                  T2 t2)

Create a new ComparableTuple with 2 elements

Type Parameters:

T1 - the first element type

T2 - the second element type

Parameters:

t1 - the first element

t2 - the second element

Returns:

the newly created ComparablePair tuple

fromEntry

static <T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>> ComparablePair<T1,T2> fromEntry(Map.Entry<? extends T1,? extends T2> entry)

Create a new ComparableTuple with 2 elements from a Map Map.Entry

Type Parameters:

T1 - the first element type

T2 - the second element type

Parameters:

entry - the map entry

Returns:

the newly created ComparablePair tuple

of

static <T1 extends Comparable<? super T1>,T2 extends Comparable<? super T2>,T3 extends Comparable<? super T3>> ComparableTriple<T1,T2,T3> of(T1 t1,
                                                                                                                                                                     T2 t2,
                                                                                                                                                                     T3 t3)

Create a new ComparableTuple with 3 elements

Type Parameters:

T1 - the first element type

T2 - the second element type

T3 - the third element type

Parameters:

t1 - the first element

t2 - the second element

t3 - the third element

Returns:

the newly created ComparableTriple tuple