Class ResourceSupport

java.lang.Object

org.junit.platform.commons.support.ResourceSupport

@API(status=MAINTAINED,
     since="1.14")
public class ResourceSupport
extends Object

ResourceSupport provides static utility methods for common tasks dealing with resources; for example, scanning for resources on the class path or module path.

TestEngine and extension authors are encouraged to use these supported methods in order to align with the behavior of the JUnit Platform.

Since:

1.14

See Also:

• AnnotationSupport
• ClassSupport
• ModifierSupport
• ReflectionSupport

Method Summary

Modifier and Type	Method	Description
static List<Resource>	findAllResourcesInClasspathRoot(URI root, ResourceFilter resourceFilter)	Find all resources in the supplied classpath root that match the specified resourceFilter.
static List<Resource>	findAllResourcesInModule(String moduleName, ResourceFilter resourceFilter)	Find all resources in the supplied moduleName that match the specified resourceFilter.
static List<Resource>	findAllResourcesInPackage(String basePackageName, ResourceFilter resourceFilter)	Find all resources in the supplied basePackageName that match the specified resourceFilter.
static Stream<Resource>	streamAllResourcesInClasspathRoot(URI root, ResourceFilter resourceFilter)	Find all resources in the supplied classpath root that match the specified resourceFilter.
static Stream<Resource>	streamAllResourcesInModule(String moduleName, ResourceFilter resourceFilter)	Find all resources in the supplied moduleName that match the specified resourceFilter.
static Stream<Resource>	streamAllResourcesInPackage(String basePackageName, ResourceFilter resourceFilter)	Find all resources in the supplied basePackageName that match the specified resourceFilter.
static Try<Set<Resource>>	tryToGetResources(String classpathResourceName)	Try to get the resources for the supplied classpath resource name.
static Try<Set<Resource>>	tryToGetResources(String classpathResourceName, ClassLoader classLoader)	Try to load the resources for the supplied classpath resource name, using the supplied ClassLoader.

Methods inherited from class Object

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

Method Details

tryToGetResources

public static Try<Set<Resource>> tryToGetResources(String classpathResourceName)

Try to get the resources for the supplied classpath resource name.

The name of a classpath resource must follow the semantics for resource paths as defined in ClassLoader.getResource(String).

If the supplied classpath resource name is prefixed with a slash (/), the slash will be removed.

Parameters:

classpathResourceName - the name of the resource to load; never null or blank

Returns:

a successful Try containing the set of loaded resources (potentially empty) or a failed Try containing the exception in case a failure occurred while trying to list resources; never null

See Also:

• tryToGetResources(String, ClassLoader)
• ReflectionSupport.tryToLoadClass(String)

tryToGetResources

public static Try<Set<Resource>> tryToGetResources(String classpathResourceName,
 ClassLoader classLoader)

Try to load the resources for the supplied classpath resource name, using the supplied ClassLoader.

The name of a classpath resource must follow the semantics for resource paths as defined in ClassLoader.getResource(String).

If the supplied classpath resource name is prefixed with a slash (/), the slash will be removed.

Parameters:

classpathResourceName - the name of the resource to load; never null or blank

classLoader - the ClassLoader to use; never null

Returns:

a successful Try containing the set of loaded resources (potentially empty) or a failed Try containing the exception in case a failure occurred while trying to list resources; never null

See Also:

• tryToGetResources(String)
• ReflectionSupport.tryToLoadClass(String, ClassLoader)

findAllResourcesInClasspathRoot

public static List<Resource> findAllResourcesInClasspathRoot(URI root,
 ResourceFilter resourceFilter)

Find all resources in the supplied classpath root that match the specified resourceFilter.

The classpath scanning algorithm searches recursively in subpackages beginning with the root of the classpath.

Parameters:

root - the URI for the classpath root in which to scan; never null

resourceFilter - the resource type filter; never null

Returns:

an immutable list of all such resources found; never null but potentially empty

See Also:

• findAllResourcesInPackage(String, ResourceFilter)
• findAllResourcesInModule(String, ResourceFilter)
• ReflectionSupport.findAllClassesInClasspathRoot(URI, Predicate, Predicate)

streamAllResourcesInClasspathRoot

public static Stream<Resource> streamAllResourcesInClasspathRoot(URI root,
 ResourceFilter resourceFilter)

Find all resources in the supplied classpath root that match the specified resourceFilter.

The classpath scanning algorithm searches recursively in subpackages beginning with the root of the classpath.

Parameters:

root - the URI for the classpath root in which to scan; never null

resourceFilter - the resource type filter; never null

Returns:

a stream of all such classes found; never null but potentially empty

See Also:

• streamAllResourcesInPackage(String, ResourceFilter)
• streamAllResourcesInModule(String, ResourceFilter)
• ReflectionSupport.streamAllClassesInClasspathRoot(URI, Predicate, Predicate)

findAllResourcesInPackage

public static List<Resource> findAllResourcesInPackage(String basePackageName,
 ResourceFilter resourceFilter)

Find all resources in the supplied basePackageName that match the specified resourceFilter.

The classpath scanning algorithm searches recursively in subpackages beginning within the supplied base package. The resulting list may include identically named resources from different classpath roots.

Parameters:

basePackageName - the name of the base package in which to start scanning; must not be null and must be valid in terms of Java syntax

resourceFilter - the resource type filter; never null

Returns:

an immutable list of all such classes found; never null but potentially empty

See Also:

• findAllResourcesInClasspathRoot(URI, ResourceFilter)
• findAllResourcesInModule(String, ResourceFilter)
• ReflectionSupport.findAllClassesInPackage(String, Predicate, Predicate)

streamAllResourcesInPackage

public static Stream<Resource> streamAllResourcesInPackage(String basePackageName,
 ResourceFilter resourceFilter)

Find all resources in the supplied basePackageName that match the specified resourceFilter.

The classpath scanning algorithm searches recursively in subpackages beginning within the supplied base package. The resulting stream may include identically named resources from different classpath roots.

Parameters:

basePackageName - the name of the base package in which to start scanning; must not be null and must be valid in terms of Java syntax

resourceFilter - the resource type filter; never null

Returns:

a stream of all such resources found; never null but potentially empty

See Also:

• streamAllResourcesInClasspathRoot(URI, ResourceFilter)
• streamAllResourcesInModule(String, ResourceFilter)
• ReflectionSupport.streamAllClassesInPackage(String, Predicate, Predicate)

findAllResourcesInModule

public static List<Resource> findAllResourcesInModule(String moduleName,
 ResourceFilter resourceFilter)

Find all resources in the supplied moduleName that match the specified resourceFilter.

The module-path scanning algorithm searches recursively in all packages contained in the module.

Parameters:

moduleName - the name of the module to scan; never null or empty

resourceFilter - the resource type filter; never null

Returns:

an immutable list of all such resources found; never null but potentially empty

See Also:

• findAllResourcesInClasspathRoot(URI, ResourceFilter)
• findAllResourcesInPackage(String, ResourceFilter)
• ReflectionSupport.findAllClassesInModule(String, Predicate, Predicate)

streamAllResourcesInModule

public static Stream<Resource> streamAllResourcesInModule(String moduleName,
 ResourceFilter resourceFilter)

Find all resources in the supplied moduleName that match the specified resourceFilter.

The module-path scanning algorithm searches recursively in all packages contained in the module.

Parameters:

moduleName - the name of the module to scan; never null or empty

resourceFilter - the resource type filter; never null

Returns:

a stream of all such resources found; never null but potentially empty

See Also:

• streamAllResourcesInClasspathRoot(URI, ResourceFilter)
• streamAllResourcesInPackage(String, ResourceFilter)
• ReflectionSupport.streamAllClassesInModule(String, Predicate, Predicate)