> ## Content Index > Fetch the complete content index at: https://www.sfeir.dev/llms.txt > Use this file to discover other available public pages before exploring further. # Java : Qu'est ce que l'API Gatherer ? - URL: https://www.sfeir.dev/back/java-gatherer/ - Published: 2025-05-26T14:20:44.000Z - Updated: 2025-05-27T07:48:45.000Z - Description: L'API Java Gatherer est arrivée. Vous voulez en savoir plus ? Pas le temps de regarder une longue vidéo explicative ? Cet article est fait pour vous ! - Author: Thibaut Rety - Tags: Back, Java, Java23, API L'API Gatherer apparaît en preview à partir de java 22\. Souvenez vous, on vous l'évoquait [ici ](https://www.sfeir.dev/back/quelles-nouveautes-arrivent-dans-java-22/)! Elle est fortement liée aux [streams](https://www.sfeir.dev/back/api-stream-definition/). Découvrez dans cet article, ce qu'elle nous permet de faire ! > ⚠️Attention ! Cet article part du principe que vous connaissez déjà les bases du langage java, en particulier les notions autour des streams. Si ce n'est pas le cas, nous vous conseillons d'aller auparavant faire un tour sur les articles suivants : > [Langage Java](https://www.sfeir.dev/back/le-langage-java-definition/) > [L'API Stream](https://www.sfeir.dev/back/api-stream-definition/) ## Un peu de contexte Java 8 a été une véritable révolution dans le monde Java. L'API [stream ](https://www.sfeir.dev/back/api-stream-definition/)a fait son apparition, facilitant de loin les travaux des développeurs. Au cours des versions successives de java, elle a été améliorée, augmentée avec des nouvelles opérations. Pour ne citer que quelques exemples : - Java 9 : **takeWhile** qui permet de parcourir le stream tant que les éléments consommés respectent la condition en paramètre - Java 9: **ofNullable** qui permet de retourner un stream contenant un seul élément s'il n'est pas null, ou un stream vide sinon - Java 16 : **mapMulti** qui permet de faire un mapping filtré sur le stream Ces opérations sont dites "non terminales" car elles retournent un stream. Il est possible, en java, d'implémenter ses propres opérations terminales (collect, reduce...), mais le besoin semble émerger d'implémenter ses propres opérations non terminales ! C'est exactement l'objectif de l'API Gatherer ! ## Alors comment ça marche ? ```java default Stream gather(Gatherer gatherer) ``` Cette méthode de Stream permet d'appliquer une opération intermédiaire définie par l'objet "gatherer" qui est une instance de l'interface "Gatherer". ### L'interface Gatherer - Elle est paramétrée par 3 types : . - **T** : Le type des éléments en entrée - **A** : Le type de l'état mutable du Gatherer (oui, oui, on peut gérer un état mutable ! Ne vous inquiétez pas on va le voir ensemble 😊) - **R** : Le type des éléments dans le stream de sortie - Elle contient 4 méthodes à connaître : - Supplier initializer() - Integrator integrator() - BinaryOperator combiner() - BiConsumer> finisher() Une fois ces méthodes maîtrisées, vous serez en mesure de créer votre propre opération intermédiaire ! ### Initializer - Objectif : Fournir la méthode d'initialisation de l'état mutable du Gatherer - Signature : **Supplier initializer();** - Le type A est le type de l'état du Gatherer ### Integrator - Objectif : Fournir le cœur de notre opération intermédiaire, définir son fonctionnement - Signature : **Integrator integrator();** - Le type A est le type de l'état du Gatherer. En effet, c'est l'intégrateur qui mettra à jour cet état mutable si nécessaire - Le type T est le type du stream d'entrée - Le type R est le type du stream de retour Integrator est une interface fonctionnelle. Sa méthode à implémenter est : ```java boolean integrate(A state, T element, Downstream downstream); ``` - *state* est l'état courant - *element* est l'élément courant du stream d'entrée. C'est sur cet élément qu'il faut faire l'opération de transformation souhaitée avant de le pousser dans le stream de sortie - downstream représente le stream de sortie. Son type est défini par l'interface fonctionnelle Downstream. Ses méthodes : - *boolean push(T element)* : méthode abstraite qui permet de pousser un élément dans le downstream - *boolean isRejecting()* : méthode qui renvoi "false" par défaut et permet de définir si le stream rejette les futurs éléments (ils ne seront pas poussés dans le stream de sortie) Son type de retour est un booléen qui définit si les éléments suivants du stream doivent être consommées. ❓Mais ce booléen et la méthode "isRejecting()" semblent redondants… Non ? > "isRejecting" empêche le push, mais continue la consommation des éléments, alors que le booléen empêche directement sa consommation ### Combiner Dans le cas du parallélisme, le combiner permet de combiner deux états de notre opération intérmédiaire pour en produire un nouveau. ```java BinaryOperator combiner() ``` ### Finisher ```java BiConsumer> finisher() ``` Cette fonction permet d'effectuer une action finale sur le stream. Par exemple, dans le cas du parallélisme, notre état mutable aura accumulé tous les états intermédiaires. Le finisher permet alors de traiter ce dernier état afin de pousser ce qu'il faut dans le downstream. ## Des factories bien pratiques ! ### Pour les gatherer ```java static Gatherer ofSequential(Integrator integrator); ``` Cette méthode permet de créer un gatherer séquentiel. Tout stream parallèle d'entrée deviendra alors séquentiel. Ce gatherer est stateless, ce qui explique le type "Void". Il est également possible de créer un gatherer séquentiel qui gère son état mutable ```java static Gatherer ofSequential(Supplier initializer, Integrator integrator) ``` Si le séquentiel n'est pas un besoin, les méthodes statiques "of" permettent de créer un Gatherer : ```java static Gatherer of(Integrator integrator); static Gatherer of(Integrator integrator, BiConsumer> finisher); static Gatherer of(Supplier initializer, Integrator integrator,BinaryOperator combiner, BiConsumer> finisher); ``` ### Pour les integrator Une méthode utilitaire à connaître est : ```java static Greedy ofGreedy(Greedy greedy) { return greedy; } ``` ❓Encore une notion ? Mais qu'est-ce encore que Greedy ? Greedy est une interface qui étend l'interface Integrator. Cette interface est une optimisation permettant de spécifier que l'integrator n'interrompra jamais un stream. L'utilisation de Greedy, dans ce cas, permet à la JVM d'optimiser le traitement. ## Implémentons une opération de filtre premier ### Objectif Implémenter une opération non terminale qui ne retient que les nombres premiers d'un stream entrant. ### Analyse - Notre opération n'interrompt pas le stream. On peut donc utiliser un Greedy integrator - On considère que l'ordre est important, on travaille donc en séquentiel et on utilisera la factory de gatherer "ofSequential" - On ne traite pas d'état mutable, on ne gèrera donc pas d'état initial ### Implémentation ```java public static void main(String[] args) { Gatherer.Integrator integrator = Gatherer.Integrator.ofGreedy((_, element, downstream) -> { if (isPrime(element)) { return downstream.push(element); } return true; }); var gatherer = Gatherer.ofSequential(integrator); List sample = List.of(0,1,2,5,7,9,11,13,15,18,19); System.out.println(sample.stream().gather(gatherer).toList()); } ``` ## Conclusion Nous avons vu que l'API Gatherer est une nouveauté permettant d'implémenter ses propres opérations non terminales sur les streams. Il en existe déjà plusieurs et elles couvrent la plupart des besoins. Seul l'avenir nous dira si elle présente une véritable utilité dans notre code java, ou s'il s'agit d'un nice-to-have répondant à des besoins spécifiques. ## Sources [The Gatherer API - Dev.javaImplementing your own intermediate operations with the Gatherer API![](https://storage.ghost.io/c/0b/31/0b31478e-a66a-46f1-8c34-d44388e21192/content/images/icon/favicon-15.ico)Dev.java: The Destination for Java Developers![](https://storage.ghost.io/c/0b/31/0b31478e-a66a-46f1-8c34-d44388e21192/content/images/thumbnail/java-logo-vert-blk.png)](https://dev.java/learn/api/streams/gatherers/?ref=sfeir.dev) [L’API Gatherers : l’outil qui manquait à vos Streams | Java & Moi![](https://storage.ghost.io/c/0b/31/0b31478e-a66a-46f1-8c34-d44388e21192/content/images/icon/cropped-java-icon-270x270.png)Java & MoiAntoine![](https://storage.ghost.io/c/0b/31/0b31478e-a66a-46f1-8c34-d44388e21192/content/images/thumbnail/word-image-2551-1-edited.jpeg)](https://javaetmoi.com/2025/04/api-gatherers-outil-qui-manquait-a-vos-streams/?ref=sfeir.dev)