Package org.junit.jupiter.engine.extension

Class MutableExtensionRegistry

java.lang.Object

org.junit.jupiter.engine.extension.MutableExtensionRegistry

All Implemented Interfaces:

ExtensionRegistrar, ExtensionRegistry

@API(status=INTERNAL,
     since="5.5")
public class MutableExtensionRegistry
extends Object
implements ExtensionRegistry, ExtensionRegistrar

Default, mutable implementation of ExtensionRegistry.

A registry has a reference to its parent registry, and all lookups are performed first in the current registry itself and then recursively in its ancestors.

Since:

5.5

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<Extension>	DEFAULT_EXTENSIONS
private static final Logger	logger
private final MutableExtensionRegistry	parent
private final List<Extension>	registeredExtensions
private final Set<Class<? extends Extension>>	registeredExtensionTypes

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MutableExtensionRegistry(MutableExtensionRegistry parent)

Method Summary

Modifier and Type	Method	Description
static MutableExtensionRegistry	createRegistryFrom(MutableExtensionRegistry parentRegistry, List<Class<? extends Extension>> extensionTypes)	Factory for creating and populating a new registry from a list of extension types and a parent registry.
static MutableExtensionRegistry	createRegistryWithDefaultExtensions(JupiterConfiguration configuration)	Factory for creating and populating a new root registry with the default extensions.
private boolean	isAlreadyRegistered(Class<? extends Extension> extensionType)	Determine if the supplied type is already registered in this registry or in a parent registry.
private static void	registerAutoDetectedExtensions(MutableExtensionRegistry extensionRegistry)
private void	registerDefaultExtension(Extension extension)
(package private) void	registerExtension(Class<? extends Extension> extensionType)	Instantiate an extension of the given type using its default constructor and register it in this registry.
private void	registerExtension(Extension extension)
void	registerExtension(Extension extension, Object source)	Register the supplied Extension, without checking if an extension of that type has already been registered.
<E extends Extension> Stream<E>	stream(Class<E> extensionType)	Stream all Extensions of the specified type that are present in this registry or one of its ancestors.
private <E extends Extension> Stream<E>	streamLocal(Class<E> extensionType)	Stream all Extensions of the specified type that are present in this registry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.jupiter.engine.extension.ExtensionRegistry

getExtensions, getReversedExtensions

Field Details

logger

private static final Logger logger

DEFAULT_EXTENSIONS

private static final List<Extension> DEFAULT_EXTENSIONS

parent

private final MutableExtensionRegistry parent

registeredExtensionTypes

private final Set<Class<? extends Extension>> registeredExtensionTypes

registeredExtensions

private final List<Extension> registeredExtensions

Constructor Details

MutableExtensionRegistry

private MutableExtensionRegistry(MutableExtensionRegistry parent)

Method Details

createRegistryWithDefaultExtensions

public static MutableExtensionRegistry createRegistryWithDefaultExtensions(JupiterConfiguration configuration)

Factory for creating and populating a new root registry with the default extensions.

If the Constants.EXTENSIONS_AUTODETECTION_ENABLED_PROPERTY_NAME configuration parameter has been set to true, extensions will be auto-detected using Java's ServiceLoader mechanism and automatically registered after the default extensions.

Parameters:

configuration - configuration parameters used to retrieve the extension auto-detection flag; never null

Returns:

a new ExtensionRegistry; never null

registerAutoDetectedExtensions

private static void registerAutoDetectedExtensions(MutableExtensionRegistry extensionRegistry)

createRegistryFrom

public static MutableExtensionRegistry createRegistryFrom(MutableExtensionRegistry parentRegistry,
 List<Class<? extends Extension>> extensionTypes)

Factory for creating and populating a new registry from a list of extension types and a parent registry.

Parameters:

parentRegistry - the parent registry

extensionTypes - the types of extensions to be registered in the new registry

Returns:

a new ExtensionRegistry; never null

stream

public <E extends Extension> Stream<E> stream(Class<E> extensionType)

Description copied from interface: ExtensionRegistry

Stream all Extensions of the specified type that are present in this registry or one of its ancestors.

Specified by:

stream in interface ExtensionRegistry

Parameters:

extensionType - the type of Extension to stream

See Also:

• ExtensionRegistry.getReversedExtensions(Class)
• ExtensionRegistry.getExtensions(Class)

streamLocal

private <E extends Extension> Stream<E> streamLocal(Class<E> extensionType)

Stream all Extensions of the specified type that are present in this registry.

Extensions in ancestors are ignored.

Parameters:

extensionType - the type of Extension to stream

See Also:

• ExtensionRegistry.getReversedExtensions(Class)

isAlreadyRegistered

private boolean isAlreadyRegistered(Class<? extends Extension> extensionType)

Determine if the supplied type is already registered in this registry or in a parent registry.

registerExtension

void registerExtension(Class<? extends Extension> extensionType)

Instantiate an extension of the given type using its default constructor and register it in this registry.

A new Extension will not be registered if an extension of the given type already exists in this registry or a parent registry.

Parameters:

extensionType - the type of extension to register

registerDefaultExtension

private void registerDefaultExtension(Extension extension)

registerExtension

private void registerExtension(Extension extension)

registerExtension

public void registerExtension(Extension extension,
 Object source)

Description copied from interface: ExtensionRegistrar

Register the supplied Extension, without checking if an extension of that type has already been registered.

Semantics for Source

If an extension is registered declaratively via @ExtendWith, the source and the extension should be the same object. However, if an extension is registered programmatically via @RegisterExtension, the source object should be the Field that is annotated with @RegisterExtension. Similarly, if an extension is registered programmatically as a lambda expression or method reference, the source object should be the underlying Method that implements the extension API.

Specified by:

registerExtension in interface ExtensionRegistrar

Parameters:

extension - the extension to register; never null

source - the source of the extension; never null