WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Java

Function.identity(): Identitätsfunktion und Finisher eines Collectors

`Function.identity()` liefert eine Funktion, die dieselbe Referenz zurückgibt. Als Finisher eines Collectors gibt sie den Sammelbehälter unverändert als Ergebnis zurück.

Version: Java SE 21

Syntax

import java.util.function.Function;

// Static method declaration in java.util.function.Function:
static <T> Function<T, T> identity()

// Typical use:
Function<String, String> same = Function.identity();

Function.identity() ist eine statische generische Methode der seit Java 8 verfügbaren Schnittstelle java.util.function.Function. Der Aufruf nimmt keine Argumente entgegen und liefert eine Function<T, T> mit demselben Eingabe- und Ergebnistyp. Ihr apply(x) verhält sich wie x -> x: Es gibt dieselbe Referenz zurück, ohne das Objekt zu kopieren oder zu verändern, und liefert für null wieder null.

Bei Collector<T, A, R> ist T der Typ der Eingabeelemente, A der Typ des Sammelbehälters und R der endgültige Ergebnistyp. finisher() liefert eine Function<A, R>. Haben A und R denselben Typ und soll der Behälter unverändert das Ergebnis sein, übergib Function.identity() an die Überladung von Collector.of mit explizitem Finisher. Soll das Ergebnis eine Kopie oder nicht veränderbar sein, muss der Finisher diese Umwandlung vornehmen.

Die Übergabe von Function.identity() als Finisher setzt IDENTITY_FINISH nicht automatisch. Mit diesem Merkmal darf die Reduktion den Finisher-Aufruf auslassen. Gib es nur an, wenn der Finisher eine Identitätsfunktion ist und eine ungeprüfte Typumwandlung von A nach R gelingt. Die Überladung von Collector.of ohne Finisher-Argument setzt das Merkmal selbst.

Verlangt eine API einen UnaryOperator<T>, verwende UnaryOperator.identity(): Das Verhalten ist dasselbe, aber der deklarierte Rückgabetyp ist UnaryOperator<T> statt Function<T, T>.

Beispiele

import java.util.ArrayList;
import java.util.List;
import java.util.function.Function;
import java.util.stream.Collector;

public class IdentityFinisherDemo {
    public static void main(String[] args) {
        Collector<String, List<String>, List<String>> collector = Collector.of(
                ArrayList::new,
                List::add,
                (left, right) -> {
                    left.addAll(right);
                    return left;
                },
                Function.identity(),
                Collector.Characteristics.IDENTITY_FINISH);

        List<String> input = List.of("Ada", "Lin");
        List<String> buffer = collector.supplier().get();
        input.forEach(name -> collector.accumulator().accept(buffer, name));
        List<String> result = collector.finisher().apply(buffer);

        System.out.println(result == buffer);
        System.out.println(input.stream().collect(collector));
    }
}

Ergebnis

true
[Ada, Lin]

Die erste Zeile, `true`, zeigt, dass `==` nach einem direkten Finisher-Aufruf dieselbe Referenz feststellt. Die zweite, `[Ada, Lin]`, zeigt die aus dem Stream gesammelten Inhalte, nicht ob der Stream den Finisher aufgerufen hat.

Zugehörige Lektionen

  • Java · Lektion 24 · Fortgeschritten · Version: 2

Quellen