Package org.junit.jupiter.engine.execution

Class NamespaceAwareStore

java.lang.Object

org.junit.jupiter.engine.execution.NamespaceAwareStore

All Implemented Interfaces:

ExtensionContext.Store

@API(status=INTERNAL,
     since="5.0")
public class NamespaceAwareStore
extends java.lang.Object
implements ExtensionContext.Store

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.ExtensionContext.Store

ExtensionContext.Store.CloseableResource

Constructor Summary

Constructors

Constructor	Description
NamespaceAwareStore(ExtensionValuesStore valuesStore, ExtensionContext.Namespace namespace)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	get(java.lang.Object key)	Get the value that is stored under the supplied key.
<T> T	get(java.lang.Object key, java.lang.Class<T> requiredType)	Get the value of the specified required type that is stored under the supplied key.
<K,V> java.lang.Object	getOrComputeIfAbsent(K key, java.util.function.Function<K,V> defaultCreator)	Get the value that is stored under the supplied key.
<K,V> V	getOrComputeIfAbsent(K key, java.util.function.Function<K,V> defaultCreator, java.lang.Class<V> requiredType)	Get the value of the specified required type that is stored under the supplied key.
void	put(java.lang.Object key, java.lang.Object value)	Store a value for later retrieval under the supplied key.
java.lang.Object	remove(java.lang.Object key)	Remove the value that was previously stored under the supplied key.
<T> T	remove(java.lang.Object key, java.lang.Class<T> requiredType)	Remove the value of the specified required type that was previously stored under the supplied key.

Methods inherited from interface org.junit.jupiter.api.extension.ExtensionContext.Store

getOrComputeIfAbsent

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceAwareStore

public NamespaceAwareStore(ExtensionValuesStore valuesStore,
                           ExtensionContext.Namespace namespace)

Method Detail

get

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

Description copied from interface: ExtensionContext.Store

Get the value that is stored under the supplied key.

If no value is stored in the current ExtensionContext for the supplied key, ancestors of the context will be queried for a value with the same key in the Namespace used to create this store.

For greater type safety, consider using ExtensionContext.Store.get(Object, Class) instead.

Specified by:

get in interface ExtensionContext.Store

Parameters:

key - the key; never null

Returns:

the value; potentially null

See Also:

ExtensionContext.Store.get(Object, Class)

get

public <T> T get(java.lang.Object key,
                 java.lang.Class<T> requiredType)

Description copied from interface: ExtensionContext.Store

Get the value of the specified required type that is stored under the supplied key.

If no value is stored in the current ExtensionContext for the supplied key, ancestors of the context will be queried for a value with the same key in the Namespace used to create this store.

Specified by:

get in interface ExtensionContext.Store

Type Parameters:

T - the value type

Parameters:

key - the key; never null

requiredType - the required type of the value; never null

Returns:

the value; potentially null

See Also:

ExtensionContext.Store.get(Object)

getOrComputeIfAbsent

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

Description copied from interface: ExtensionContext.Store

Get the value that is stored under the supplied key.

If no value is stored in the current ExtensionContext for the supplied key, ancestors of the context will be queried for a value with the same key in the Namespace used to create this store. If no value is found for the supplied key, a new value will be computed by the defaultCreator (given the key as input), stored, and returned.

For greater type safety, consider using ExtensionContext.Store.getOrComputeIfAbsent(Object, Function, Class) instead.

If the created value is an instance of ExtensionContext.Store.CloseableResource the close() method will be invoked on the stored object when the store is closed.

Specified by:

getOrComputeIfAbsent in interface ExtensionContext.Store

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key; never null

defaultCreator - the function called with the supplied key to create a new value; never null

Returns:

the value; potentially null

See Also:

ExtensionContext.Store.getOrComputeIfAbsent(Class), ExtensionContext.Store.getOrComputeIfAbsent(Object, Function, Class), ExtensionContext.Store.CloseableResource

getOrComputeIfAbsent

public <K,V> V getOrComputeIfAbsent(K key,
                                    java.util.function.Function<K,V> defaultCreator,
                                    java.lang.Class<V> requiredType)

Description copied from interface: ExtensionContext.Store

Get the value of the specified required type that is stored under the supplied key.

If no value is stored in the current ExtensionContext for the supplied key, ancestors of the context will be queried for a value with the same key in the Namespace used to create this store. If no value is found for the supplied key, a new value will be computed by the defaultCreator (given the key as input), stored, and returned.

If requiredType implements ExtensionContext.Store.CloseableResource the close() method will be invoked on the stored object when the store is closed.

Specified by:

getOrComputeIfAbsent in interface ExtensionContext.Store

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key; never null

defaultCreator - the function called with the supplied key to create a new value; never null

requiredType - the required type of the value; never null

Returns:

the value; potentially null

See Also:

ExtensionContext.Store.getOrComputeIfAbsent(Class), ExtensionContext.Store.getOrComputeIfAbsent(Object, Function), ExtensionContext.Store.CloseableResource

put

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

Description copied from interface: ExtensionContext.Store

Store a value for later retrieval under the supplied key.

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

If the value is an instance of ExtensionContext.Store.CloseableResource the close() method will be invoked on the stored object when the store is closed.

Specified by:

put in interface ExtensionContext.Store

Parameters:

key - the key under which the value should be stored; never null

value - the value to store; may be null

See Also:

ExtensionContext.Store.CloseableResource

remove

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

Description copied from interface: ExtensionContext.Store

Remove the value that was previously stored under the supplied key.

The value will only be removed in the current ExtensionContext, not in ancestors. In addition, the ExtensionContext.Store.CloseableResource API will not be honored for values that are manually removed via this method.

For greater type safety, consider using ExtensionContext.Store.remove(Object, Class) instead.

Specified by:

remove in interface ExtensionContext.Store

Parameters:

key - the key; never null

Returns:

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

See Also:

ExtensionContext.Store.remove(Object, Class)

remove

public <T> T remove(java.lang.Object key,
                    java.lang.Class<T> requiredType)

Description copied from interface: ExtensionContext.Store

Remove the value of the specified required type that was previously stored under the supplied key.

The value will only be removed in the current ExtensionContext, not in ancestors. In addition, the ExtensionContext.Store.CloseableResource API will not be honored for values that are manually removed via this method.

Specified by:

remove in interface ExtensionContext.Store

Type Parameters:

T - the value type

Parameters:

key - the key; never null

requiredType - the required type of the value; never null

Returns:

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

See Also:

ExtensionContext.Store.remove(Object)