org.junit.jupiter.params.provider.EmptySource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junit-jupiter-params Show documentation

Module "junit-jupiter-params" of JUnit 5.

There is a newer version: 5.11.3

/*
 * Copyright 2015-2024 the original author or authors.
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v2.0 which
 * accompanies this distribution and is available at
 *
 * https://www.eclipse.org/legal/epl-v20.html
 */

package org.junit.jupiter.params.provider;

import static org.apiguardian.api.API.Status.STABLE;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.apiguardian.api.API;

/**
 * {@code @EmptySource} is an {@link ArgumentsSource} which provides a single
 * empty argument to the annotated {@code @ParameterizedTest} method.
 *
 * Supported Parameter Types
 *
 * This argument source will only provide an empty argument for the following
 * method parameter types.
 *
 * 

 * {@link java.lang.String}
 * {@link java.util.Collection} and concrete subtypes with a public no-arg constructor
 * {@link java.util.List}
 * {@link java.util.Set}
 * {@link java.util.SortedSet}
 * {@link java.util.NavigableSet}
 * {@link java.util.Map} and concrete subtypes with a public no-arg constructor
 * {@link java.util.SortedMap}
 * {@link java.util.NavigableMap}
 * primitive arrays — for example {@code int[]}, {@code char[][]}, etc.
 * object arrays — for example {@code String[]}, {@code Integer[][]}, etc.
 * 
 *
 * @since 5.4
 * @see org.junit.jupiter.params.provider.ArgumentsSource
 * @see org.junit.jupiter.params.ParameterizedTest
 * @see NullSource
 * @see NullAndEmptySource
 */
@Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@API(status = STABLE, since = "5.7")
@ArgumentsSource(EmptyArgumentsProvider.class)
@SuppressWarnings("exports")
public @interface EmptySource {
}