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

Class Namespace

  • @API(status=MAINTAINED,
     since="1.13.3")
public class Namespace
extends java.lang.Object
    A Namespace is used to provide a scope for data saved by extensions within a NamespacedHierarchicalStore.

    Storing data in custom namespaces allows extensions to avoid accidentally mixing data between extensions or across different invocations within the lifecycle of a single extension.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Namespace GLOBAL
      The default, global namespace which allows access to stored data from all extensions.
      private java.util.List<java.lang.Object> parts  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Namespace​(java.util.List<java.lang.Object> parts)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Namespace append​(java.lang.Object... parts)
      Create a new namespace by appending the supplied parts to the existing sequence of parts in this namespace.
      static Namespace create​(java.lang.Object... parts)
      Create a namespace which restricts access to data to all extensions which use the same sequence of parts for creating a namespace.
      static Namespace create​(java.util.List<java.lang.Object> objects)
      Create a namespace which restricts access to data to all extensions which use the same sequence of objects for creating a namespace.
      boolean equals​(java.lang.Object o)  
      int hashCode()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • GLOBAL

        public static final Namespace GLOBAL
        The default, global namespace which allows access to stored data from all extensions.

      • parts

        private final java.util.List<java.lang.Object> parts

    • Constructor Detail

      • Namespace

        private Namespace​(java.util.List<java.lang.Object> parts)

    • Method Detail

      • create

        public static Namespace create​(java.lang.Object... parts)
        Create a namespace which restricts access to data to all extensions which use the same sequence of parts for creating a namespace.

        The order of the parts is significant.

        Internally the parts are compared using Object.equals(Object).

      • create

        public static Namespace create​(java.util.List<java.lang.Object> objects)
        Create a namespace which restricts access to data to all extensions which use the same sequence of objects for creating a namespace.

        The order of the objects is significant.

        Internally the objects are compared using Object.equals(Object).

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • append

        public Namespace append​(java.lang.Object... parts)
        Create a new namespace by appending the supplied parts to the existing sequence of parts in this namespace.
        Returns:
        new namespace; never null