Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util

Interface Comparators.KeyProvider<T,K>

Type Parameters:

T - The type to order.

K - The key type that is used to determine the order; this may be the same as the type itself.

All Known Implementing Classes:

ListBasedComparator.SimpleKeyProvider

Enclosing class:

Comparators

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@API(status=STABLE,
     since="0.0.5")
@ClassVersion(sourceVersion="$Id: Comparators.java 1084 2024-01-03 15:31:20Z tquadrat $")
@FunctionalInterface
public static interface Comparators.KeyProvider<T,K>

Implementations of this interface provides the sort order key from the given instance of the type.

Usually the implementation of getKey() must ensure that the returned keys are distinct for distinct arguments. This means for the arguments a1 and a2, and the generated keys ka1 and ka2 that the following must be both true:

• a1 = a2 ⇔ ka1 = ka2
• a1 ≠ a2 ⇔ ka1 ≠ ka2

This also requires that getKey() for the same argument must provide always the same key.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Comparators.java 1084 2024-01-03 15:31:20Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.Comparators.KeyProvider"

⁠

Method Summary

Modifier and Type	Method	Description
K	getKey(T instance)	Returns the sort order key for the given instance.

Method Details

getKey

K getKey(T instance)

Returns the sort order key for the given instance.

Parameters:

instance - The instance; may be null.

Returns:

The respective sort order key; will be null if the instance was null.