JUnit 5 5.10.2 · org.junit.platform.engine.ConfigurationParameters

Modifier and Type	Field and Description
public static final String	CONFIG_FILE_NAME Name of the JUnit Platform configuration file: junit-platform.properties.

Method Summary

Modifier and Type	Method and Description
public Optional<String>	Returns: an `Optional` containing the value; never `null` but potentially empty get(String the key to look up; never `null` or blank key) Get the configuration parameter stored under the specified `key`.
public default <T> Optional<T>	Returns: an `Optional` containing the value; never `null` but potentially empty get(String the key to look up; never `null` or blank key, Function<String, T> the transformer to apply in case a value is found; never `null` transformer) Get and transform the configuration parameter stored under the specified `key` using the specified `transformer`.
public Optional<Boolean>	Returns: an `Optional` containing the value; never `null` but potentially empty getBoolean(String the key to look up; never `null` or blank key) Get the boolean configuration parameter stored under the specified `key`.
public Set<String>	Returns: the set of keys contained in this `ConfigurationParameters` keySet() Get the keys of all configuration parameters stored in this `ConfigurationParameters`.
public int	size() Deprecated as of JUnit Platform 1.9 in favor of `keySet()` Get the number of configuration parameters stored directly in this `ConfigurationParameters`.

CONFIG_FILE_NAME	back to summary
public static final String CONFIG_FILE_NAME Name of the JUnit Platform configuration file: junit-platform.properties. If a properties file with this name is present in the root of the classpath, it will be used as a source for configuration parameters. If multiple files are present, only the first one detected in the classpath will be used. See Also `java.util.Properties`

Method Detail

get back to summary

get	back to summary
public Optional<String> get(String key) Get the configuration parameter stored under the specified `key`. If no such key is present in this `ConfigurationParameters`, an attempt will be made to look up the value as a JVM system property. If no such system property exists, an attempt will be made to look up the value in the JUnit Platform properties file. Parameters key:String the key to look up; never `null` or blank Returns:Optional<String> an `Optional` containing the value; never `null` but potentially empty See Also `getBoolean(String)`, `System#getProperty(String)`, `CONFIG_FILE_NAME`

public Optional<String> get(String key)

Get the configuration parameter stored under the specified key.

If no such key is present in this ConfigurationParameters, an attempt will be made to look up the value as a JVM system property. If no such system property exists, an attempt will be made to look up the value in the JUnit Platform properties file.

Parameters

key:String: the key to look up; never null or blank

Returns:Optional<String>

an Optional containing the value; never null but potentially empty

get back to summary

get	back to summary
public default <T> Optional<T> get(String key, Function<String, T> transformer) Get and transform the configuration parameter stored under the specified `key` using the specified `transformer`. If no such key is present in this `ConfigurationParameters`, an attempt will be made to look up the value as a JVM system property. If no such system property exists, an attempt will be made to look up the value in the JUnit Platform properties file. In case the transformer throws an exception, it will be wrapped in a `JUnitException` with a helpful message. Parameters key:String the key to look up; never `null` or blank transformer:Function<String, T> the transformer to apply in case a value is found; never `null` Returns:Optional<T> an `Optional` containing the value; never `null` but potentially empty Annotations @API status:STABLE since:1.3 Since 1.3 See Also `getBoolean(String)`, `System#getProperty(String)`, `CONFIG_FILE_NAME`

public default <T> Optional<T> get(String key, Function<String, T> transformer)

Get and transform the configuration parameter stored under the specified key using the specified transformer.

In case the transformer throws an exception, it will be wrapped in a JUnitException with a helpful message.

Parameters

key:String: the key to look up; never null or blank
transformer:Function<String, T>: the transformer to apply in case a value is found; never null

Returns:Optional<T>

an Optional containing the value; never null but potentially empty

Annotations

@API
status:STABLE
since:1.3

Since

1.3

getBoolean back to summary

getBoolean	back to summary
public Optional<Boolean> getBoolean(String key) Get the boolean configuration parameter stored under the specified `key`. If no such key is present in this `ConfigurationParameters`, an attempt will be made to look up the value as a JVM system property. If no such system property exists, an attempt will be made to look up the value in the JUnit Platform properties file. Parameters key:String the key to look up; never `null` or blank Returns:Optional<Boolean> an `Optional` containing the value; never `null` but potentially empty See Also `get(String)`, `Boolean#parseBoolean(String)`, `System#getProperty(String)`, `CONFIG_FILE_NAME`

public Optional<Boolean> getBoolean(String key)

Get the boolean configuration parameter stored under the specified key.

Parameters

key:String: the key to look up; never null or blank

Returns:Optional<Boolean>

an Optional containing the value; never null but potentially empty

keySet back to summary

keySet	back to summary
public Set<String> keySet() Get the keys of all configuration parameters stored in this `ConfigurationParameters`. Returns:Set<String> the set of keys contained in this `ConfigurationParameters` Annotations @API status:STABLE since:1.9

public Set<String> keySet()

Get the keys of all configuration parameters stored in this ConfigurationParameters.

Returns:Set<String>

the set of keys contained in this ConfigurationParameters

Annotations

@API
status:STABLE
since:1.9

size back to summary

size	back to summary
public int size() Deprecated as of JUnit Platform 1.9 in favor of `keySet()` Get the number of configuration parameters stored directly in this `ConfigurationParameters`. Annotations @Deprecated @API status:DEPRECATED since:1.9

public int size()

Deprecated

as of JUnit Platform 1.9 in favor of keySet()

Get the number of configuration parameters stored directly in this ConfigurationParameters.

Annotations

@Deprecated
@API
status:DEPRECATED
since:1.9

public Interface ConfigurationParameters

Field Summary

Method Summary

Field Detail

Method Detail