Package org.junit.platform.engine.support.discovery

Interface SelectorResolver

@API(status=EXPERIMENTAL,
     since="1.5")
public interface SelectorResolver

A resolver that supports resolving one or multiple types of DiscoverySelectors.

An implementation of a resolve() method is typically comprised of the following steps:

1. Check whether the selector is applicable for the current TestEngine and the current EngineDiscoveryRequest (e.g. for a test class: is it relevant for the current engine and does it pass all filters in the request?).
2. If so, use the supplied Context, to add one or multiple TestDescriptors to the designated parent (see Context for details) and return a match or multiple matches. Alternatively, convert the supplied selector into one or multiple other selectors (e.g. a PackageSelector into a set of ClassSelectors). Otherwise, return unresolved().

Since:

1.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SelectorResolver.Context	The context for resolving a DiscoverySelector and adding it to the test tree.
static class	SelectorResolver.Match	An exact or partial match for resolving a DiscoverySelector into a TestDescriptor.
static class	SelectorResolver.Resolution	The result of an attempt to resolve a DiscoverySelector.

Method Summary

Modifier and Type	Method	Description
default SelectorResolver.Resolution	resolve(ClasspathResourceSelector selector, SelectorResolver.Context context)	Resolve the supplied ClasspathResourceSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(ClasspathRootSelector selector, SelectorResolver.Context context)	Resolve the supplied ClasspathRootSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(ClassSelector selector, SelectorResolver.Context context)	Resolve the supplied ClassSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(DirectorySelector selector, SelectorResolver.Context context)	Resolve the supplied DirectorySelector using the supplied Context.
default SelectorResolver.Resolution	resolve(FileSelector selector, SelectorResolver.Context context)	Resolve the supplied FileSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(MethodSelector selector, SelectorResolver.Context context)	Resolve the supplied MethodSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(ModuleSelector selector, SelectorResolver.Context context)	Resolve the supplied ModuleSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(PackageSelector selector, SelectorResolver.Context context)	Resolve the supplied PackageSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(UniqueIdSelector selector, SelectorResolver.Context context)	Resolve the supplied UniqueIdSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(UriSelector selector, SelectorResolver.Context context)	Resolve the supplied UriSelector using the supplied Context.
default SelectorResolver.Resolution	resolve(DiscoverySelector selector, SelectorResolver.Context context)	Resolve the supplied DiscoverySelector using the supplied Context.

Method Detail

resolve

default SelectorResolver.Resolution resolve(ClasspathResourceSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied ClasspathResourceSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(ClasspathRootSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied ClasspathRootSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(ClassSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied ClassSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(DirectorySelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied DirectorySelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(FileSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied FileSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(MethodSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied MethodSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(ModuleSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied ModuleSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(PackageSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied PackageSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(UniqueIdSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied UniqueIdSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(UriSelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied UriSelector using the supplied Context.

The default implementation simply delegates to resolve(DiscoverySelector, Context).

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

resolve(DiscoverySelector, Context)

resolve

default SelectorResolver.Resolution resolve(DiscoverySelector selector,
                                            SelectorResolver.Context context)

Resolve the supplied DiscoverySelector using the supplied Context.

This method is only called if none of the overloaded variants match.

The default implementation returns unresolved().

Parameters:

selector - the selector to be resolved; never null

context - the context to be used for resolving the selector; never null

Returns:

a Resolution of unresolved(), selectors(), or matches(); never null

See Also:

SelectorResolver.Context