Class NamespacedHierarchicalStore<N>

java.lang.Object
org.junit.platform.engine.support.store.NamespacedHierarchicalStore<N>
Type Parameters:
N - Namespace type
All Implemented Interfaces:
AutoCloseable
@API(status=MAINTAINED, since="1.13.3") public final class NamespacedHierarchicalStore<N> extends Object implements 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

  • Constructor Details

    • NamespacedHierarchicalStore

      public NamespacedHierarchicalStore(@Nullable 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(@Nullable NamespacedHierarchicalStore<N> parentStore, @Nullable 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 Details

    • newChild

      public NamespacedHierarchicalStore<N> newChild()
      Create a child store with this store as its parent and this store's close action.

    • getParent

      @API(status=EXPERIMENTAL, since="6.0") public 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

      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 AutoCloseable
      See Also:

    • get

      public @Nullable Object get(N namespace, 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> @Nullable T get(N namespace, Object key, 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

      @Deprecated(since="6.0") @API(status=DEPRECATED, since="6.0") public <K, V extends @Nullable Object> @Nullable Object getOrComputeIfAbsent(N namespace, K key, Function<? super K, ? extends V> defaultCreator)
      Deprecated.
      Please use computeIfAbsent(Object, Object, Function) instead.
      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

    • computeIfAbsent

      @API(status=MAINTAINED, since="6.0") public <K,V> Object computeIfAbsent(N namespace, K key, Function<? super K, ? extends V> defaultCreator)
      Return the value stored for the supplied namespace and key in this store or the parent store, if present and not null, 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 and must not return null
      Returns:
      the stored value; never null
      Throws:
      NamespacedHierarchicalStoreException - if this store has already been closed
      Since:
      6.0

    • getOrComputeIfAbsent

      @Deprecated(since="6.0") @API(status=DEPRECATED, since="6.0") public <K, V extends @Nullable Object> @Nullable V getOrComputeIfAbsent(N namespace, K key, Function<? super K, ? extends V> defaultCreator, Class<V> requiredType) throws NamespacedHierarchicalStoreException
      Deprecated.
      Please use computeIfAbsent(Object, Object, Function, Class) instead.
      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

    • computeIfAbsent

      @API(status=MAINTAINED, since="6.0") public <K,V> V computeIfAbsent(N namespace, K key, Function<? super K, ? extends V> defaultCreator, Class<V> requiredType) throws NamespacedHierarchicalStoreException
      Return the value stored for the supplied namespace and key in this store or the parent store, if present and not null, 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 and must not return null
      requiredType - the required type of the value; never null
      Returns:
      the stored value; never null
      Throws:
      NamespacedHierarchicalStoreException - if the stored value cannot be cast to the required type, or if this store has already been closed
      Since:
      6.0

    • put

      public @Nullable Object put(N namespace, Object key, @Nullable 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 @Nullable Object remove(N namespace, 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> @Nullable T remove(N namespace, Object key, 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