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

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

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

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

Inheritance

This annotation is inherited to subclasses.

Nested and Inner Type Summary

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

Method Summary

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

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

from back to summary

from	back to summary
public 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. Annotations @API status:MAINTAINED since:5.13.3 Since 5.12 See Also `value`, `names`, `to`, `mode`

public 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.

Annotations

@API
status:MAINTAINED
since:5.13.3

Since

5.12

See Also

value, names, to, mode

mode back to summary

mode	back to summary
public 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 `Mode#INCLUDE`, `Mode#EXCLUDE`, `Mode#MATCH_ALL`, `Mode#MATCH_ANY`, `Mode#MATCH_NONE`, `names`, `from`, `to`

public 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: Mode#INCLUDE, Mode#EXCLUDE, Mode#MATCH_ALL, Mode#MATCH_ANY, Mode#MATCH_NONE, names, from, to

names back to summary

names	back to summary
public 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`

public 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

to back to summary

to	back to summary
public 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. Annotations @API status:MAINTAINED since:5.13.3 Since 5.12 See Also `value`, `names`, `from`, `mode`

public 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.

Annotations

@API
status:MAINTAINED
since:5.13.3

Since

5.12

See Also

value, names, from, mode

value back to summary

value	back to summary
public 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`

public 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

org.junit.jupiter.params.provider back to summary

public final Enum EnumSource.Mode

Class Inheritance

extends Enum<EnumSource.Mode>

java.lang.Object
java.lang.Enum
org.junit.jupiter.params.provider.EnumSource.Mode

Enumeration of modes for selecting enum constants by name.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static interface	EnumSource.Mode.Validator

Field Summary

Modifier and Type	Field and Description
public static final EnumSource.Mode	EXCLUDE Select all declared enum constants except those supplied via the `EnumSource#names` attribute.
public static final EnumSource.Mode	INCLUDE Select only those enum constants whose names are supplied via the `EnumSource#names` attribute.
public static final EnumSource.Mode	MATCH_ALL Select only those enum constants whose names match all patterns supplied via the `EnumSource#names` attribute.
public static final EnumSource.Mode	MATCH_ANY Select only those enum constants whose names match any pattern supplied via the `EnumSource#names` attribute.
public static final EnumSource.Mode	MATCH_NONE Select only those enum constants whose names match none of the patterns supplied via the `EnumSource#names` attribute.
private final BiPredicate<String, Set<String>>	selector
private final EnumSource.Mode.Validator	validator

Constructor Summary

Access	Constructor and Description
private	Mode(EnumSource.Mode.Validator validator, BiPredicate<String, Set<String>> selector)

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	select(Enum<?> constant, Set<String> names)
pack-priv void	validate(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)
private static void	validateNames(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)
private static void	validatePatterns(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)
public static EnumSource.Mode	valueOf(String name)
public static EnumSource.Mode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EXCLUDE	back to summary
public static final EnumSource.Mode EXCLUDE Select all declared enum constants except those supplied via the `EnumSource#names` attribute.

INCLUDE	back to summary
public static final EnumSource.Mode INCLUDE Select only those enum constants whose names are supplied via the `EnumSource#names` attribute.

MATCH_ALL back to summary

MATCH_ALL	back to summary
public static final EnumSource.Mode MATCH_ALL Select only those enum constants whose names match all patterns supplied via the `EnumSource#names` attribute. See Also `java.util.stream.Stream#allMatch(java.util.function.Predicate)`

public static final EnumSource.Mode MATCH_ALL

Select only those enum constants whose names match all patterns supplied via the EnumSource#names attribute.

See Also: java.util.stream.Stream#allMatch(java.util.function.Predicate)

MATCH_ANY back to summary

MATCH_ANY	back to summary
public static final EnumSource.Mode MATCH_ANY Select only those enum constants whose names match any pattern supplied via the `EnumSource#names` attribute. See Also `java.util.stream.Stream#anyMatch(java.util.function.Predicate)`

public static final EnumSource.Mode MATCH_ANY

Select only those enum constants whose names match any pattern supplied via the EnumSource#names attribute.

See Also: java.util.stream.Stream#anyMatch(java.util.function.Predicate)

MATCH_NONE	back to summary
public static final EnumSource.Mode MATCH_NONE Select only those enum constants whose names match none of the patterns supplied via the `EnumSource#names` attribute. Annotations @API status:MAINTAINED since:5.13.3 Since 5.9 See Also `java.util.stream.Stream#noneMatch(java.util.function.Predicate)`

selector	back to summary
private final BiPredicate<String, Set<String>> selector

validator	back to summary
private final EnumSource.Mode.Validator validator

Constructor Detail

Mode	back to summary
private Mode(EnumSource.Mode.Validator validator, BiPredicate<String, Set<String>> selector)

Method Detail

select	back to summary
pack-priv boolean select(Enum<?> constant, Set<String> names)

validate	back to summary
pack-priv void validate(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)

validateNames	back to summary
private static void validateNames(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)

validatePatterns	back to summary
private static void validatePatterns(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)

valueOf	back to summary
public static EnumSource.Mode valueOf(String name)

values	back to summary
public static EnumSource.Mode[] values()

org.junit.jupiter.params.provider back to summary

private Interface EnumSource.Mode.Validator

Method Summary

Modifier and Type	Method and Description
public void	validate(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)

Method Detail

validate	back to summary
public void validate(EnumSource enumSource, Set<? extends Enum<?>> constants, Set<String> names)

public @Interface EnumSource

Inheritance

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum EnumSource.Mode

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface EnumSource.Mode.Validator

Method Summary

Method Detail