org.junit.gen5.api.extension

Interface ExtensionContext.Store

Enclosing interface:

ExtensionContext

public static interface ExtensionContext.Store

Store provides methods for extensions to save and retrieve data.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.Object key) Get an object that has been stored using a key.
java.lang.Object	getOrComputeIfAbsent(java.lang.Object key, java.util.function.Function<java.lang.Object,java.lang.Object> defaultCreator) Get the object that is stored under the supplied key.
void	put(java.lang.Object key, java.lang.Object value) Store a value for later retrieval using a key.
java.lang.Object	remove(java.lang.Object key) Remove a value that was previously stored using key so that key can be used anew.

Method Detail

get

java.lang.Object get(java.lang.Object key)

Get an object that has been stored using a key.

If no value has been saved in the current ExtensionContext for this key, the ancestors are asked for a value with the same key in the store's Namespace.

Parameters:

key - the key

Returns:

the value

put

void put(java.lang.Object key,
         java.lang.Object value)

Store a value for later retrieval using a key. null is a valid value.

A stored value is visible in offspring ExtensionContexts for the store's Namespace unless they overwrite it.

Parameters:

key - the key

value - the value

getOrComputeIfAbsent

java.lang.Object getOrComputeIfAbsent(java.lang.Object key,
                                      java.util.function.Function<java.lang.Object,java.lang.Object> defaultCreator)

Get the object that is stored under the supplied key.

If no value is currently stored under the supplied key, a new value will be computed by the defaultCreator, stored, and returned.

Parameters:

key - the key

defaultCreator - the function called to create new values

Returns:

the value

remove

java.lang.Object remove(java.lang.Object key)

Remove a value that was previously stored using key so that key can be used anew.

The key will only be removed in the current ExtensionContext not in ancestors.

Parameters:

key - the key

Returns:

the previous value or null if no value was present for the specified key