Top Description Fields Constructors Methods
org.junit.platform.engine.support.store

public final Class Namespace

extends Object
Class Inheritance
Annotations
@API
status:EXPERIMENTAL
since:6.0
Static Imports
org.apiguardian.api.API.Status.EXPERIMENTAL

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

Modifier and TypeField and Description
public static final Namespace
GLOBAL

The default, global namespace which allows access to stored data from all extensions.

private final List<Object>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public Namespace

Returns:

new namespace; never null
append
(Object... parts)

Create a new namespace by appending the supplied parts to the existing sequence of parts in this namespace.

public static Namespace
create(Object... parts)

Create a namespace which restricts access to data to all extensions which use the same sequence of parts for creating a namespace.

public static Namespace
create(List<Object> objects)

Create a namespace which restricts access to data to all extensions which use the same sequence of objects for creating a namespace.

public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

GLOBALback to summary
public static final Namespace GLOBAL

The default, global namespace which allows access to stored data from all extensions.

partsback to summary
private final List<Object> parts

Constructor Detail

Namespaceback to summary
private Namespace(List<Object> parts)

Method Detail

appendback to summary
public Namespace append(Object... parts)

Create a new namespace by appending the supplied parts to the existing sequence of parts in this namespace.

Returns:Namespace

new namespace; never null

createback to summary
public static Namespace create(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).

createback to summary
public static Namespace create(List<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).

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override