org.junit.jupiter.params.provider.CsvSource Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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.EXPERIMENTAL;
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 @CsvSource} is an {@link ArgumentsSource} which reads
* comma-separated values (CSV) from one or more supplied
* {@linkplain #value CSV lines}.
*
* The column delimiter (defaults to comma) can be customized with either
* {@link #delimiter()} or {@link #delimiterString()}.
*
*
The supplied values will be provided as arguments to the
* annotated {@code @ParameterizedTest} method.
*
* @since 5.0
* @see CsvFileSource
* @see org.junit.jupiter.params.provider.ArgumentsSource
* @see org.junit.jupiter.params.ParameterizedTest
*/
@Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@API(status = STABLE, since = "5.7")
@ArgumentsSource(CsvArgumentsProvider.class)
public @interface CsvSource {
/**
* The CSV lines to use as the source of arguments; must not be empty.
*
*
Each value corresponds to a line in a CSV file and will be split using
* the specified {@link #delimiter} or {@link #delimiterString}. Any line
* beginning with a {@code #} symbol will be interpreted as a comment and will
* be ignored.
*/
String[] value();
/**
* The column delimiter character to use when reading the {@linkplain #value lines}.
*
*
This is an alternative to {@link #delimiterString} and cannot be
* used in conjunction with {@link #delimiterString}.
*
*
Defaults implicitly to {@code ','}, if neither delimiter attribute is
* explicitly set.
*/
char delimiter() default '\0';
/**
* The column delimiter string to use when reading the {@linkplain #value lines}.
*
*
This is an alternative to {@link #delimiter} and cannot be used in
* conjunction with {@link #delimiter}.
*
*
Defaults implicitly to {@code ","}, if neither delimiter attribute is
* explicitly set.
*
* @since 5.6
*/
String delimiterString() default "";
/**
* The empty value to use when reading the {@linkplain #value lines}.
*
*
This value replaces quoted empty strings read from the input.
*
*
Defaults to {@code ""}.
*
* @since 5.5
*/
String emptyValue() default "";
/**
* A list of strings that should be interpreted as {@code null} references.
*
*
For example, you may wish for certain values such as {@code "N/A"} or
* {@code "NIL"} to be converted to {@code null} references.
*
*
Please note that unquoted empty values will always be converted
* to {@code null} references regardless of the value of this {@code nullValues}
* attribute; whereas, a quoted empty string will be treated as an
* {@link #emptyValue}.
*
*
Defaults to {@code {}}.
*
* @since 5.6
*/
String[] nullValues() default {};
/**
* The maximum characters of per CSV column allowed.
*
*
Must be a positive number.
*
*
Defaults to {@code 4096}.
*
* @since 5.7
*/
@API(status = EXPERIMENTAL, since = "5.7")
int maxCharsPerColumn() default 4096;
}