Module org.junit.jupiter.params

Package org.junit.jupiter.params.provider

Annotation Interface EnumSource

@Target({ANNOTATION_TYPE,METHOD})
@Retention(RUNTIME)
@Documented
@Repeatable(EnumSources.class)
@API(status=STABLE,
     since="5.7")
@ArgumentsSource(org.junit.jupiter.params.provider.EnumArgumentsProvider.class)
public @interface EnumSource

@EnumSource is a repeatable ArgumentsSource for constants of an Enum.

The enum constants will be provided as arguments to the annotated @ParameterizedTest method.

The enum type can be specified explicitly using the value() attribute. Otherwise, the declared type of the first parameter of the @ParameterizedTest method is used.

The set of enum constants can be restricted via the names(), from(), to() and mode() attributes.

Since:

5.0

See Also:

• ArgumentsSource
• ParameterizedTest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EnumSource.Mode	Enumeration of modes for selecting enum constants by name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	from	The starting enum constant of the range to be included.
EnumSource.Mode	mode	The enum constant selection mode.
String[]	names	The names of enum constants to provide, or regular expressions to select the names of enum constants to provide.
String	to	The ending enum constant of the range to be included.
Class<? extends Enum<?>>	value	The enum type that serves as the source of the enum constants.

Element Details

value

Class<? extends Enum<?>> value

The enum type that serves as the source of the enum constants.

If this attribute is not set explicitly, the declared type of the first parameter of the @ParameterizedTest method is used.

See Also:

• names()
• from()
• to()
• mode()

Default:

org.junit.jupiter.params.provider.NullEnum.class

names

String[] names

The names of enum constants to provide, or regular expressions to select the names of enum constants to provide.

If no names or regular expressions are specified, and neither from() nor to() are specified, all enum constants declared in the specified enum type will be provided.

If from() or to() are specified, the elements in names must fall within the range defined by from() and to().

The mode() determines how the names are interpreted.

See Also:

• value()
• from()
• to()
• mode()

Default:

{}

from

@API(status=EXPERIMENTAL,
     since="5.12")
String from

The starting enum constant of the range to be included.

Defaults to an empty string, where the range starts from the first enum constant of the specified enum type.

Since:

5.12

See Also:

• value()
• names()
• to()
• mode()

Default:

""

to

@API(status=EXPERIMENTAL,
     since="5.12")
String to

The ending enum constant of the range to be included.

Defaults to an empty string, where the range ends at the last enum constant of the specified enum type.

Since:

5.12

See Also:

• value()
• names()
• from()
• mode()

Default:

""

mode

EnumSource.Mode mode

The enum constant selection mode.

The mode only applies to the names() attribute and does not change the behavior of from() and to(), which always define a range based on the natural order of the enum constants.

Defaults to INCLUDE.

See Also:

• EnumSource.Mode.INCLUDE
• EnumSource.Mode.EXCLUDE
• EnumSource.Mode.MATCH_ALL
• EnumSource.Mode.MATCH_ANY
• EnumSource.Mode.MATCH_NONE
• names()
• from()
• to()

Default:

INCLUDE