Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Java

Builder fluente com tipo próprio

Um tipo próprio genérico mantém disponíveis os métodos da subclasse após uma chamada herdada. `build()` cria um produto separado a partir do estado atual.

Versão: Java SE 21

Sintaxe

Declaration sketch (method bodies omitted):
abstract class TaskBuilder<S extends TaskBuilder<S>> {
    protected abstract S self();
    public final S tag(String value) { /* mutate this builder, then return self() */ }
    public abstract Task build();
}
final class PriorityTaskBuilder extends TaskBuilder<PriorityTaskBuilder> {
    @Override protected PriorityTaskBuilder self() { return this; }
    @Override public PriorityTask build() { /* return a new product */ }
}
// PriorityTask extends Task.

Um builder mutável acumula opções de configuração. tag(...) altera o builder atual e devolve a mesma instância através de self(), não uma cópia nem o produto final. Aqui, == verifica a identidade do objeto, não a igualdade do conteúdo.

Em TaskBuilder<S extends TaskBuilder<S>>, S aparece no seu próprio limite superior. PriorityTaskBuilder usa o seu próprio tipo como S, pelo que se pode chamar priority(...) logo após o método herdado tag(...). O método abstrato self() permite que a classe concreta devolva this sem uma conversão de tipo não verificada. O limite, por si só, não obriga a subclasse a usar o seu próprio tipo nem obriga self() a devolver a instância atual.

A declaração de base de build() devolve Task. A subclasse do builder redefine o método com o tipo de retorno covariante PriorityTask, um subtipo de Task: é uma redefinição, não uma sobrecarga. Através da referência base, o resultado tem o tipo estático Task, embora seja executado o método da subclasse.

Cada chamada a build() cria um novo produto que captura o estado atual. List.copyOf devolve uma lista não modificável que não é afetada por alterações posteriores à lista do builder. A cópia é superficial: os elementos String são imutáveis, mas elementos mutáveis exigiriam cópias defensivas adicionais para isolar o seu estado. tag(null) lança imediatamente NullPointerException, antes de alterar a lista.

Exemplos

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

public class FluentBuilderDemo {
    static class Task {
        private final List<String> tags;

        private Task(TaskBuilder<?> builder) {
            tags = List.copyOf(builder.tags);
        }

        public final List<String> tags() {
            return tags;
        }
    }

    static final class PriorityTask extends Task {
        private final int priority;

        private PriorityTask(PriorityTaskBuilder builder) {
            super(builder);
            priority = builder.priority;
        }

        public int priority() {
            return priority;
        }
    }

    static abstract class TaskBuilder<S extends TaskBuilder<S>> {
        private final List<String> tags = new ArrayList<>();

        protected abstract S self();

        public final S tag(String value) {
            tags.add(Objects.requireNonNull(value, "tag"));
            return self();
        }

        public abstract Task build();
    }

    static final class PriorityTaskBuilder extends TaskBuilder<PriorityTaskBuilder> {
        private int priority;

        @Override
        protected PriorityTaskBuilder self() {
            return this;
        }

        public PriorityTaskBuilder priority(int value) {
            priority = value;
            return self();
        }

        @Override
        public PriorityTask build() {
            return new PriorityTask(this);
        }
    }

    public static void main(String[] args) {
        PriorityTaskBuilder builder = new PriorityTaskBuilder();
        System.out.println(builder.tag("draft").priority(5) == builder);

        TaskBuilder<PriorityTaskBuilder> base = builder;
        Task first = base.build();
        PriorityTask second = builder.tag("review").build();

        System.out.println("first: " + String.join(", ", first.tags()));
        System.out.println("second: " + String.join(", ", second.tags()));
        System.out.println("priority: " + second.priority());
    }
}

Resultado

true
first: draft
second: draft, review
priority: 5

`true` confirma que a cadeia devolve o mesmo builder. A adição de `review` afeta o segundo resultado, mas não o primeiro.

Lições relacionadas

  • Java · Lição 3 · Avançado · Versão: 2
  • Java · Lição 16 · Avançado · Versão: 2

Fontes