Package org.junit.platform.engine.support.store

Class NamespacedHierarchicalStore<N>

java.lang.Object

org.junit.platform.engine.support.store.NamespacedHierarchicalStore<N>

Type Parameters:

N - Namespace type

All Implemented Interfaces:

java.lang.AutoCloseable

@API(status=MAINTAINED,
     since="1.13.3")
public final class NamespacedHierarchicalStore<N>
extends java.lang.Object
implements java.lang.AutoCloseable

NamespacedHierarchicalStore is a hierarchical, namespaced key-value store.

Its closing behavior can be customized by passing a NamespacedHierarchicalStore.CloseAction to the NamespacedHierarchicalStore(NamespacedHierarchicalStore, CloseAction) constructor.

This class is thread-safe. Please note, however, that thread safety is not guaranteed while the close() method is being invoked.

Since:

1.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NamespacedHierarchicalStore.CloseAction<N>	Called for each successfully stored non-null value in the store when a NamespacedHierarchicalStore is closed.
private static class	NamespacedHierarchicalStore.CompositeKey<N>
private static class	NamespacedHierarchicalStore.EvaluatedValue<N>
private static class	NamespacedHierarchicalStore.MemoizingSupplier	Thread-safe Supplier that memoizes the result of calling its delegate and ensures it is called at most once.
private static class	NamespacedHierarchicalStore.StoredValue

Field Summary

Fields

Modifier and Type	Field	Description
private NamespacedHierarchicalStore.CloseAction<N>	closeAction
private boolean	closed
private java.util.concurrent.atomic.AtomicInteger	insertOrderSequence
private NamespacedHierarchicalStore<N>	parentStore
private java.util.concurrent.ConcurrentMap<NamespacedHierarchicalStore.CompositeKey<N>,NamespacedHierarchicalStore.StoredValue>	storedValues

Constructor Summary

Constructors

Constructor	Description
NamespacedHierarchicalStore(NamespacedHierarchicalStore<N> parentStore)	Create a new store with the supplied parent.
NamespacedHierarchicalStore(NamespacedHierarchicalStore<N> parentStore, NamespacedHierarchicalStore.CloseAction<N> closeAction)	Create a new store with the supplied parent and close action.

Method Summary

Modifier and Type	Method	Description
private <T> T	castToRequiredType(java.lang.Object key, java.lang.Object value, java.lang.Class<T> requiredType)
void	close()	If a NamespacedHierarchicalStore.CloseAction is configured, it will be called with all successfully stored values in reverse insertion order.
java.lang.Object	get(N namespace, java.lang.Object key)	Get the value stored for the supplied namespace and key in this store or the parent store, if present.
<T> T	get(N namespace, java.lang.Object key, java.lang.Class<T> requiredType)	Get the value stored for the supplied namespace and key in this store or the parent store, if present, and cast it to the supplied required type.
<K,V> java.lang.Object	getOrComputeIfAbsent(N namespace, K key, java.util.function.Function<K,V> defaultCreator)	Get the value stored for the supplied namespace and key in this store or the parent store, if present, or call the supplied function to compute it.
<K,V> V	getOrComputeIfAbsent(N namespace, K key, java.util.function.Function<K,V> defaultCreator, java.lang.Class<V> requiredType)	Get the value stored for the supplied namespace and key in this store or the parent store, if present, or call the supplied function to compute it and, finally, cast it to the supplied required type.
java.util.Optional<NamespacedHierarchicalStore<N>>	getParent()	Returns the parent store of this NamespacedHierarchicalStore.
private NamespacedHierarchicalStore.StoredValue	getStoredValue(NamespacedHierarchicalStore.CompositeKey<N> compositeKey)
boolean	isClosed()	Determine if this store has been closed.
NamespacedHierarchicalStore<N>	newChild()	Create a child store with this store as its parent and this store's close action.
java.lang.Object	put(N namespace, java.lang.Object key, java.lang.Object value)	Put the supplied value for the supplied namespace and key into this store and return the previously associated value in this store.
private void	rejectIfClosed()
java.lang.Object	remove(N namespace, java.lang.Object key)	Remove the value stored for the supplied namespace and key from this store.
<T> T	remove(N namespace, java.lang.Object key, java.lang.Class<T> requiredType)	Remove the value stored for the supplied namespace and key from this store and cast it to the supplied required type.
private NamespacedHierarchicalStore.StoredValue	storedValue(java.util.function.Supplier<java.lang.Object> value)

Methods inherited from class java.lang.Object

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

Field Detail

insertOrderSequence

private final java.util.concurrent.atomic.AtomicInteger insertOrderSequence

storedValues

private final java.util.concurrent.ConcurrentMap<NamespacedHierarchicalStore.CompositeKey<N>,NamespacedHierarchicalStore.StoredValue> storedValues

parentStore

private final NamespacedHierarchicalStore<N> parentStore

closeAction

private final NamespacedHierarchicalStore.CloseAction<N> closeAction

closed

private volatile boolean closed

Constructor Detail

NamespacedHierarchicalStore

public NamespacedHierarchicalStore(NamespacedHierarchicalStore<N> parentStore)

Create a new store with the supplied parent.

Parameters:

parentStore - the parent store to use for lookups; may be null

NamespacedHierarchicalStore

public NamespacedHierarchicalStore(NamespacedHierarchicalStore<N> parentStore,
                                   NamespacedHierarchicalStore.CloseAction<N> closeAction)

Create a new store with the supplied parent and close action.

Parameters:

parentStore - the parent store to use for lookups; may be null

closeAction - the action to be called for each stored value when this store is closed; may be null

Method Detail

newChild

public NamespacedHierarchicalStore<N> newChild()

Create a child store with this store as its parent and this store's close action.

getParent

@API(status=MAINTAINED,
     since="5.13.3")
public java.util.Optional<NamespacedHierarchicalStore<N>> getParent()

Returns the parent store of this NamespacedHierarchicalStore.

If this store does not have a parent, an empty Optional is returned.

Returns:

an Optional containing the parent store, or an empty Optional if there is no parent

Since:

1.13

isClosed

@API(status=MAINTAINED,
     since="1.13.3")
public boolean isClosed()

Determine if this store has been closed.

Returns:

true if this store has been closed

Since:

1.11

See Also:

close()

close

public void close()

If a NamespacedHierarchicalStore.CloseAction is configured, it will be called with all successfully stored values in reverse insertion order.

Closing a store does not close its parent or any of its children.

Invocations of this method after the store has already been closed will be ignored.

Specified by:

close in interface java.lang.AutoCloseable

See Also:

isClosed()

get

public java.lang.Object get(N namespace,
                            java.lang.Object key)

Get the value stored for the supplied namespace and key in this store or the parent store, if present.

Parameters:

namespace - the namespace; never null

key - the key; never null

Returns:

the stored value; may be null

Throws:

NamespacedHierarchicalStoreException - if this store has already been closed

get

public <T> T get(N namespace,
                 java.lang.Object key,
                 java.lang.Class<T> requiredType)
          throws NamespacedHierarchicalStoreException

Get the value stored for the supplied namespace and key in this store or the parent store, if present, and cast it to the supplied required type.

Parameters:

namespace - the namespace; never null

key - the key; never null

requiredType - the required type of the value; never null

Returns:

the stored value; may be null

Throws:

NamespacedHierarchicalStoreException - if the stored value cannot be cast to the required type, or if this store has already been closed

getOrComputeIfAbsent

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

Get the value stored for the supplied namespace and key in this store or the parent store, if present, or call the supplied function to compute it.

Parameters:

namespace - the namespace; never null

key - the key; never null

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

Returns:

the stored value; may be null

Throws:

NamespacedHierarchicalStoreException - if this store has already been closed

getOrComputeIfAbsent

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

Get the value stored for the supplied namespace and key in this store or the parent store, if present, or call the supplied function to compute it and, finally, cast it to the supplied required type.

Parameters:

namespace - the namespace; never null

key - the key; never null

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

requiredType - the required type of the value; never null

Returns:

the stored value; may be null

Throws:

NamespacedHierarchicalStoreException - if the stored value cannot be cast to the required type, or if this store has already been closed

put

public java.lang.Object put(N namespace,
                            java.lang.Object key,
                            java.lang.Object value)
                     throws NamespacedHierarchicalStoreException

Put the supplied value for the supplied namespace and key into this store and return the previously associated value in this store.

The NamespacedHierarchicalStore.CloseAction will not be called for the previously stored value, if any.

Parameters:

namespace - the namespace; never null

key - the key; never null

value - the value to store; may be null

Returns:

the previously stored value; may be null

Throws:

NamespacedHierarchicalStoreException - if an error occurs while storing the value, or if this store has already been closed

remove

public java.lang.Object remove(N namespace,
                               java.lang.Object key)

Remove the value stored for the supplied namespace and key from this store.

The NamespacedHierarchicalStore.CloseAction will not be called for the removed value.

Parameters:

namespace - the namespace; never null

key - the key; never null

Returns:

the previously stored value; may be null

Throws:

NamespacedHierarchicalStoreException - if this store has already been closed

remove

public <T> T remove(N namespace,
                    java.lang.Object key,
                    java.lang.Class<T> requiredType)
             throws NamespacedHierarchicalStoreException

Remove the value stored for the supplied namespace and key from this store and cast it to the supplied required type.

The NamespacedHierarchicalStore.CloseAction will not be called for the removed value.

Parameters:

namespace - the namespace; never null

key - the key; never null

requiredType - the required type of the value; never null

Returns:

the previously stored value; may be null

Throws:

NamespacedHierarchicalStoreException - if the stored value cannot be cast to the required type, or if this store has already been closed

storedValue

private NamespacedHierarchicalStore.StoredValue storedValue(java.util.function.Supplier<java.lang.Object> value)

getStoredValue

private NamespacedHierarchicalStore.StoredValue getStoredValue(NamespacedHierarchicalStore.CompositeKey<N> compositeKey)

castToRequiredType

private <T> T castToRequiredType(java.lang.Object key,
                                 java.lang.Object value,
                                 java.lang.Class<T> requiredType)

rejectIfClosed

private void rejectIfClosed()