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 java.lang.Object
implements ExtensionRegistry, ExtensionRegistrar

Default, mutable implementation of ExtensionRegistry.

Since:

5.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	MutableExtensionRegistry.Entry
private static class	MutableExtensionRegistry.LateInitEntry
private static class	MutableExtensionRegistry.LateInitExtensions

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.List<org.junit.jupiter.api.extension.Extension>	DEFAULT_STATELESS_EXTENSIONS
private java.util.Map<java.lang.Class<?>,MutableExtensionRegistry.LateInitExtensions>	lateInitExtensions
private static org.junit.platform.commons.logging.Logger	logger
private java.util.List<MutableExtensionRegistry.Entry>	registeredExtensions
private java.util.Set<java.lang.Class<? extends org.junit.jupiter.api.extension.Extension>>	registeredExtensionTypes

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MutableExtensionRegistry()
private	MutableExtensionRegistry(java.util.Set<java.lang.Class<? extends org.junit.jupiter.api.extension.Extension>> registeredExtensionTypes, java.util.List<MutableExtensionRegistry.Entry> registeredExtensions)
private	MutableExtensionRegistry(MutableExtensionRegistry parent)

Method Summary

Modifier and Type	Method	Description
private java.lang.String	buildSourceInfo(java.lang.Object source)
static MutableExtensionRegistry	createRegistryFrom(MutableExtensionRegistry parentRegistry, java.util.stream.Stream<java.lang.Class<? extends org.junit.jupiter.api.extension.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 MutableExtensionRegistry.LateInitExtensions	getLateInitExtensions(java.lang.Class<?> testClass)
void	initializeExtensions(java.lang.Class<?> testClass, java.lang.Object testInstance)	Initialize all registered extensions for the supplied testClass using the supplied testInstance.
private boolean	isAlreadyRegistered(java.lang.Class<? extends org.junit.jupiter.api.extension.Extension> extensionType)	Determine if the supplied type is already registered in this registry or in a parent registry.
private static void	logExcludedExtensions(java.util.List<java.lang.Class<? extends org.junit.jupiter.api.extension.Extension>> excludedExtensions)
private void	registerAutoDetectedExtension(org.junit.jupiter.api.extension.Extension extension)
private static void	registerAutoDetectedExtensions(MutableExtensionRegistry extensionRegistry, JupiterConfiguration configuration)
private void	registerDefaultExtension(org.junit.jupiter.api.extension.Extension extension)
void	registerExtension(java.lang.Class<? extends org.junit.jupiter.api.extension.Extension> extensionType)	Instantiate an extension of the given type using its default constructor and register it in the registry.
private void	registerExtension(java.lang.String category, org.junit.jupiter.api.extension.Extension extension)
private void	registerExtension(java.lang.String category, org.junit.jupiter.api.extension.Extension extension, java.lang.Object source)
void	registerExtension(org.junit.jupiter.api.extension.Extension extension, java.lang.Object source)	Register the supplied Extension, without checking if an extension of that type has already been registered.
private void	registerLocalExtension(org.junit.jupiter.api.extension.Extension extension)
void	registerSyntheticExtension(org.junit.jupiter.api.extension.Extension extension, java.lang.Object source)	Register the supplied Extension as a synthetic extension, without checking if an extension of that type has already been registered.
void	registerUninitializedExtension(java.lang.Class<?> testClass, java.lang.reflect.Field source, java.util.function.Function<java.lang.Object,? extends org.junit.jupiter.api.extension.Extension> initializer)	Register an uninitialized extension for the supplied testClass to be initialized using the supplied initializer when an instance of the test class is created.
<E extends org.junit.jupiter.api.extension.Extension> java.util.stream.Stream<E>	stream(java.lang.Class<E> extensionType)	Stream all Extensions of the specified type that are present in this registry or one of its ancestors.

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

Field Detail

logger

private static final org.junit.platform.commons.logging.Logger logger

DEFAULT_STATELESS_EXTENSIONS

private static final java.util.List<org.junit.jupiter.api.extension.Extension> DEFAULT_STATELESS_EXTENSIONS

registeredExtensionTypes

private final java.util.Set<java.lang.Class<? extends org.junit.jupiter.api.extension.Extension>> registeredExtensionTypes

registeredExtensions

private final java.util.List<MutableExtensionRegistry.Entry> registeredExtensions

lateInitExtensions

private final java.util.Map<java.lang.Class<?>,MutableExtensionRegistry.LateInitExtensions> lateInitExtensions

Constructor Detail

MutableExtensionRegistry

private MutableExtensionRegistry()

MutableExtensionRegistry

private MutableExtensionRegistry(MutableExtensionRegistry parent)

MutableExtensionRegistry

private MutableExtensionRegistry(java.util.Set<java.lang.Class<? extends org.junit.jupiter.api.extension.Extension>> registeredExtensionTypes,
                                 java.util.List<MutableExtensionRegistry.Entry> registeredExtensions)

Method Detail

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.

If the "junit.jupiter.execution.timeout.threaddump.enabled" configuration parameter has been set to true, the PreInterruptThreadDumpPrinter will be registered.

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,
                                                   JupiterConfiguration configuration)

logExcludedExtensions

private static void logExcludedExtensions(java.util.List<java.lang.Class<? extends org.junit.jupiter.api.extension.Extension>> excludedExtensions)

createRegistryFrom

public static MutableExtensionRegistry createRegistryFrom(MutableExtensionRegistry parentRegistry,
                                                          java.util.stream.Stream<java.lang.Class<? extends org.junit.jupiter.api.extension.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 org.junit.jupiter.api.extension.Extension> java.util.stream.Stream<E> stream(java.lang.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.getExtensions(Class)

registerExtension

public void registerExtension(java.lang.Class<? extends org.junit.jupiter.api.extension.Extension> extensionType)

Description copied from interface: ExtensionRegistrar

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

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

Specified by:

registerExtension in interface ExtensionRegistrar

Parameters:

extensionType - the type of extension to register

isAlreadyRegistered

private boolean isAlreadyRegistered(java.lang.Class<? extends org.junit.jupiter.api.extension.Extension> extensionType)

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

registerExtension

public void registerExtension(org.junit.jupiter.api.extension.Extension extension,
                              java.lang.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

registerSyntheticExtension

public void registerSyntheticExtension(org.junit.jupiter.api.extension.Extension extension,
                                       java.lang.Object source)

Description copied from interface: ExtensionRegistrar

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

Specified by:

registerSyntheticExtension in interface ExtensionRegistrar

Parameters:

extension - the extension to register; never null

source - the source of the extension; never null

See Also:

ExtensionRegistrar.registerExtension(Extension, Object)

registerUninitializedExtension

public void registerUninitializedExtension(java.lang.Class<?> testClass,
                                           java.lang.reflect.Field source,
                                           java.util.function.Function<java.lang.Object,? extends org.junit.jupiter.api.extension.Extension> initializer)

Description copied from interface: ExtensionRegistrar

Register an uninitialized extension for the supplied testClass to be initialized using the supplied initializer when an instance of the test class is created.

Uninitialized extensions are typically registered for fields annotated with @RegisterExtension that cannot be initialized until an instance of the test class is created. Until they are initialized, such extensions are not available for use.

Specified by:

registerUninitializedExtension in interface ExtensionRegistrar

Parameters:

testClass - the test class for which the extension is registered; never null

source - the source of the extension; never null

initializer - the initializer function to be used to create the extension; never null

initializeExtensions

public void initializeExtensions(java.lang.Class<?> testClass,
                                 java.lang.Object testInstance)

Description copied from interface: ExtensionRegistrar

Initialize all registered extensions for the supplied testClass using the supplied testInstance.

Specified by:

initializeExtensions in interface ExtensionRegistrar

Parameters:

testClass - the test class for which the extensions are initialized; never null

testInstance - the test instance to be used to initialize the extensions; never null

getLateInitExtensions

private MutableExtensionRegistry.LateInitExtensions getLateInitExtensions(java.lang.Class<?> testClass)

registerDefaultExtension

private void registerDefaultExtension(org.junit.jupiter.api.extension.Extension extension)

registerAutoDetectedExtension

private void registerAutoDetectedExtension(org.junit.jupiter.api.extension.Extension extension)

registerLocalExtension

private void registerLocalExtension(org.junit.jupiter.api.extension.Extension extension)

registerExtension

private void registerExtension(java.lang.String category,
                               org.junit.jupiter.api.extension.Extension extension)

registerExtension

private void registerExtension(java.lang.String category,
                               org.junit.jupiter.api.extension.Extension extension,
                               java.lang.Object source)

buildSourceInfo

private java.lang.String buildSourceInfo(java.lang.Object source)