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

CKTIS / Java

Objects.requireNonNull: verificação de referências

Em Java SE 21, `Objects.requireNonNull` devolve a mesma referência se não for `null`; caso contrário, lança uma exceção. A verificação não valida o conteúdo do objeto.

Versão: Java SE 21

Sintaxe

import java.util.Objects;
import java.util.function.Supplier;

// Method signatures in java.util.Objects (Java SE 21):
public static <T> T requireNonNull(T obj)
public static <T> T requireNonNull(T obj, String message)
public static <T> T requireNonNull(T obj, Supplier<String> messageSupplier)

Objects.requireNonNull é um método estático genérico de java.util.Objects. Se obj não for null, o método devolve a mesma referência como T, pelo que podes usar o resultado diretamente numa atribuição. Se obj for null, não devolve um valor alternativo. Lança NullPointerException, a menos que, na sobrecarga com Supplier, get() lance uma exceção; nesse caso, é essa exceção que se propaga.

A variante com um só argumento não recebe mensagem. Com a sobrecarga String, Java avalia a expressão da mensagem antes da chamada, mesmo que obj não seja null. Com Supplier<String>, Java também avalia a expressão que fornece o Supplier antes da chamada, mas o método só invoca get() para produzir a mensagem se obj for null e o Supplier não for null. As duas primeiras variantes existem desde Java 7 e a variante com Supplier desde Java 8. O literal null como segundo argumento é ambíguo sem uma conversão explícita de tipo.

O construtor de Contact rejeita null separadamente para cada um dos três argumentos de texto: firstName, lastName e email. As cadeias vazias passam nesta verificação, e o formato do endereço de correio eletrónico tem de ser validado à parte.

Em tryAdvance, verifica action antes de verificar se o intervalo está esgotado. Com uma ação válida, não haver elementos restantes dá false; se restar um elemento, o método passa-o à ação e devolve true quando esta termina normalmente. Uma ação null provoca NullPointerException mesmo depois de o intervalo se esgotar.

Exemplos

import java.util.Objects;
import java.util.Spliterator;
import java.util.function.IntConsumer;

public class Main {
    record Contact(String firstName, String lastName, String email) {
        Contact {
            Objects.requireNonNull(firstName, "firstName");
            Objects.requireNonNull(lastName, "lastName");
            Objects.requireNonNull(email, "email");
        }
    }

    static final class Range implements Spliterator.OfInt {
        private int next = 7;
        private final int end = 8;

        @Override
        public boolean tryAdvance(IntConsumer action) {
            Objects.requireNonNull(action, "action");
            if (next >= end) {
                return false;
            }
            action.accept(next++);
            return true;
        }

        @Override public Spliterator.OfInt trySplit() { return null; }
        @Override public long estimateSize() { return end - next; }
        @Override public int characteristics() { return ORDERED | SIZED; }
    }

    public static void main(String[] args) {
        System.out.println(new Contact("Ada", "Lee", "not-an-email").email());
        try {
            new Contact("Ada", "Lee", null);
        } catch (NullPointerException ex) {
            System.out.println(ex.getClass().getSimpleName() + ": " + ex.getMessage());
        }

        Range range = new Range();
        IntConsumer print = System.out::println;
        System.out.println(range.tryAdvance(print));
        System.out.println(range.tryAdvance(print));
        try {
            range.tryAdvance((IntConsumer) null);
        } catch (NullPointerException ex) {
            System.out.println(ex.getClass().getSimpleName() + ": " + ex.getMessage());
        }
    }
}

Resultado

not-an-email
NullPointerException: email
7
true
false
NullPointerException: action

`not-an-email` passa na verificação, mas `null` em `email` provoca uma exceção. O intervalo passa `7` à ação, depois devolve `false` com uma ação válida e continua a rejeitar `null` na última chamada. A conversão `(IntConsumer) null` seleciona a sobrecarga para o tipo primitivo.

Lições relacionadas

  • Java · Lição 8 · Avançado · Versão: 2
  • Java · Lição 23 · Avançado · Versão: 2

Fontes