Class ClassLoaderClassPathResourceLoader

java.lang.Object

io.micronaut.core.io.scan.ClassLoaderClassPathResourceLoader

All Implemented Interfaces:

ResourceLoader, ClassPathResourceLoader

@NullMarked
public final class ClassLoaderClassPathResourceLoader
extends Object
implements ClassPathResourceLoader

A simple ClassPathResourceLoader that uses a ClassLoader.

Since:

5.0

Author:

Denis Stepanov

Constructor Summary

Constructors

Constructor	Description
ClassLoaderClassPathResourceLoader()
ClassLoaderClassPathResourceLoader(ClassLoader classLoader)
ClassLoaderClassPathResourceLoader(ClassLoader classLoader, String basePath)

Method Summary

Modifier and Type	Method	Description
ResourceLoader	forBase(String basePath)	Constructs a new resource loader designed to load resources from the given path.
ClassLoader	getClassLoader()	Returns the underlying classloader used by this ClassPathResourceLoader.
Optional<URL>	getResource(String path)	Obtains the URL to a given resource.
Optional<InputStream>	getResourceAsStream(String path)	Obtains a resource as a stream.
Stream<URL>	getResources(String name)	Obtains all resources with the given name.

Methods inherited from class Object

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

Methods inherited from interface ClassPathResourceLoader

handleResourceDuplicates, supportsPrefix

Methods inherited from interface ResourceLoader

reportResourceDuplicates

Constructor Details

ClassLoaderClassPathResourceLoader

public ClassLoaderClassPathResourceLoader()

ClassLoaderClassPathResourceLoader

public ClassLoaderClassPathResourceLoader(ClassLoader classLoader)

ClassLoaderClassPathResourceLoader

public ClassLoaderClassPathResourceLoader(ClassLoader classLoader,
 String basePath)

Method Details

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: ClassPathResourceLoader

Returns the underlying classloader used by this ClassPathResourceLoader.

Specified by:

getClassLoader in interface ClassPathResourceLoader

Returns:

The underlying classloader used by this ClassPathResourceLoader

getResourceAsStream

public Optional<InputStream> getResourceAsStream(String path)

Description copied from interface: ResourceLoader

Obtains a resource as a stream.

Specified by:

getResourceAsStream in interface ResourceLoader

Parameters:

path - The path

Returns:

An optional resource

getResource

public Optional<URL> getResource(String path)

Description copied from interface: ResourceLoader

Obtains the URL to a given resource.

Specified by:

getResource in interface ResourceLoader

Parameters:

path - The path

Returns:

An optional resource

getResources

public Stream<URL> getResources(String name)

Description copied from interface: ResourceLoader

Obtains all resources with the given name.

Specified by:

getResources in interface ResourceLoader

Parameters:

name - The name of the resource

Returns:

A stream of URLs

forBase

public ResourceLoader forBase(String basePath)

Description copied from interface: ResourceLoader

Constructs a new resource loader designed to load resources from the given path. Requested resources will be loaded within the context of the given path.

Specified by:

forBase in interface ResourceLoader

Parameters:

basePath - The path to load resources

Returns:

The new ResourceLoader