sirius.kernel.commons

Class ComparableTuple<F extends Comparable<F>,S>

java.lang.Object

sirius.kernel.commons.Tuple<F,S>

sirius.kernel.commons.ComparableTuple<F,S>

Type Parameters:

F - defines the first type of the tuple. The supplied class must implement Comparable

S - defines the second type of the tuple

All Implemented Interfaces:

Comparable<ComparableTuple<F,S>>

public class ComparableTuple<F extends Comparable<F>,S>
extends Tuple<F,S>
implements Comparable<ComparableTuple<F,S>>

Provides a tuple of values where the key is used as comparator.

Subclasses Tuple to implement Comparable based on the key, that is the first element of the tuple.

See Also:

Tuple, Comparable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComparableTuple(F first, S second)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ComparableTuple<F,S> o)
static <F extends Comparable<F>,S> ComparableTuple<F,S>	create(F first) Creates a new tuple by only specifying the first value of the tuple.
static <F extends Comparable<F>,S> ComparableTuple<F,S>	create(F first, S second) Creates a new tuple with the given values.
static <F extends Comparable<F>,S> ComparableTuple<F,S>	createTuple() Creates a new tuple without any values.
boolean	equals(Object obj)
static <K extends Comparable<K>,V> List<ComparableTuple<K,V>>	fromComparableMap(Map<K,V> map) Converts a map into a list of tuples.
int	hashCode()

Methods inherited from class sirius.kernel.commons.Tuple

create, firsts, flatten, fromMap, getFirst, getSecond, seconds, setFirst, setSecond, toMap, toMap, toMap, toMultiMap, toString, valueOf

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparableTuple

protected ComparableTuple(F first,
                          S second)

Method Detail

createTuple

@Nonnull
public static <F extends Comparable<F>,S> ComparableTuple<F,S> createTuple()

Creates a new tuple without any values.

Type Parameters:

F - the type for the first value

S - the type for the second value

Returns:

the newly created tuple

create

@Nonnull
public static <F extends Comparable<F>,S> ComparableTuple<F,S> create(@Nullable
                                                                               F first)

Creates a new tuple by only specifying the first value of the tuple.

The second value will remain null.

Type Parameters:

F - the type for the first value

S - the type for the second value

Parameters:

first - defines the first value of the tuple

Returns:

the newly created tuple

create

@Nonnull
public static <F extends Comparable<F>,S> ComparableTuple<F,S> create(@Nullable
                                                                               F first,
                                                                               @Nullable
                                                                               S second)

Creates a new tuple with the given values.

Type Parameters:

F - the type for the first value

S - the type for the second value

Parameters:

first - defines the first value of the tuple

second - defines the second value of the tuple

Returns:

the newly created tuple

fromComparableMap

public static <K extends Comparable<K>,V> List<ComparableTuple<K,V>> fromComparableMap(@Nonnull
                                                                                       Map<K,V> map)

Converts a map into a list of tuples.

Type Parameters:

K - the key type of the map and therefore the type of the first component of the tuples

V - the value type of the map and therefore the type of the second component of the tuples

Parameters:

map - the map to be converted

Returns:

a list of tuples, containing one tuple per map entry where the first component is the key, and the second component is the value of the map entry.

compareTo

public int compareTo(ComparableTuple<F,S> o)

Specified by:

compareTo in interface Comparable<ComparableTuple<F extends Comparable<F>,S>>

equals

public boolean equals(Object obj)

Overrides:

equals in class Tuple<F extends Comparable<F>,S>

hashCode

public int hashCode()

Overrides:

hashCode in class Tuple<F extends Comparable<F>,S>