Module org.junit.platform.engine

Package org.junit.platform.engine.support.config

Class PrefixedConfigurationParameters

java.lang.Object

org.junit.platform.engine.support.config.PrefixedConfigurationParameters

All Implemented Interfaces:

ConfigurationParameters

@API(status=EXPERIMENTAL,
     since="1.3")
public class PrefixedConfigurationParameters
extends Object
implements ConfigurationParameters

View of ConfigurationParameters that applies a supplied prefix to all queries.

Since:

1.3

Field Summary

Fields inherited from interface org.junit.platform.engine.ConfigurationParameters

CONFIG_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
PrefixedConfigurationParameters(ConfigurationParameters delegate, String prefix)	Create a new view of the supplied ConfigurationParameters that applies the supplied prefix to all queries.

Method Summary

Modifier and Type	Method	Description
Optional<String>	get(String key)	Get the configuration parameter stored under the specified key.
<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.
Optional<Boolean>	getBoolean(String key)	Get the boolean configuration parameter stored under the specified key.
int	size()	Get the number of configuration parameters stored directly in this ConfigurationParameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrefixedConfigurationParameters

public PrefixedConfigurationParameters(ConfigurationParameters delegate,
String prefix)

Create a new view of the supplied ConfigurationParameters that applies the supplied prefix to all queries.

Parameters:

delegate - the ConfigurationParameters to delegate to; never null

prefix - the prefix to apply to all queries; never null or blank

Method Details

get

public Optional<String> get(String key)

Description copied from interface: ConfigurationParameters

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.

Specified by:

get in interface ConfigurationParameters

Parameters:

key - the key to look up; never null or blank

Returns:

an Optional containing the value; never null but potentially empty

See Also:

ConfigurationParameters.getBoolean(String), System.getProperty(String), ConfigurationParameters.CONFIG_FILE_NAME

getBoolean

public Optional<Boolean> getBoolean(String key)

Description copied from interface: ConfigurationParameters

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.

Specified by:

getBoolean in interface ConfigurationParameters

Parameters:

key - the key to look up; never null or blank

Returns:

an Optional containing the value; never null but potentially empty

See Also:

ConfigurationParameters.get(String), Boolean.parseBoolean(String), System.getProperty(String), ConfigurationParameters.CONFIG_FILE_NAME

get

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

Description copied from interface: ConfigurationParameters

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.

Specified by:

get in interface ConfigurationParameters

Parameters:

key - the key to look up; never null or blank

transformer - the transformer to apply in case a value is found; never null

Returns:

an Optional containing the value; never null but potentially empty

See Also:

ConfigurationParameters.getBoolean(String), System.getProperty(String), ConfigurationParameters.CONFIG_FILE_NAME

size

public int size()

Description copied from interface: ConfigurationParameters

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

Specified by:

size in interface ConfigurationParameters