Class DefaultResourceLoader.ClassPathAllResource

java.lang.Object

org.springframework.core.io.AbstractResource

org.springframework.core.io.AbstractFileResolvingResource

org.springframework.core.io.ClassPathResource

org.springframework.core.io.DefaultResourceLoader.ClassPathAllResource

All Implemented Interfaces:

InputStreamSource, Resource

Enclosing class:

DefaultResourceLoader

protected static class DefaultResourceLoader.ClassPathAllResource
extends ClassPathResource

A multi-content ClassPathResource handle that can expose the content from all matching resources in the classpath.

Since:

7.1

Author:

Juergen Hoeller

Constructor Summary

Constructors

Constructor	Description
ClassPathAllResource(String path, @Nullable ClassLoader classLoader)

Method Summary

Modifier and Type	Method	Description
void	consumeContent(IOConsumer<InputStream> consumer)	Process the contents of this resource through the given consumer callback.
long	contentLength()	This method reads the entire InputStream to determine the content length.
Resource	createRelative(String relativePath)	This implementation creates a ClassPathResource, applying the given path relative to the path used to create this descriptor.
String	getDescription()	This implementation returns a description that includes the absolute class path location.
InputStream	getInputStream()	This implementation opens an InputStream for the underlying class path resource, if available.
URL	getURL()	This implementation returns a URL for the underlying class path resource, if available.
boolean	isFile()	This implementation always returns false.

Methods inherited from class ClassPathResource

equals, exists, getClassLoader, getFilename, getPath, hashCode, isReadable, resolveURL

Methods inherited from class AbstractFileResolvingResource

customizeConnection, customizeConnection, getFile, getFile, getFileForLastModifiedCheck, isFile, lastModified, readableChannel

Methods inherited from class AbstractResource

getURI, isOpen, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Resource

getContentAsByteArray, getContentAsString, getFilePath

Constructor Details

ClassPathAllResource

public ClassPathAllResource(String path,
 @Nullable ClassLoader classLoader)

Method Details

isFile

public boolean isFile()

Description copied from class: AbstractResource

This implementation always returns false.

Specified by:

isFile in interface Resource

Overrides:

isFile in class AbstractFileResolvingResource

See Also:

• Resource.getFile()
• Resource.getFilePath()

getURL

public URL getURL()
           throws IOException

Description copied from class: ClassPathResource

This implementation returns a URL for the underlying class path resource, if available.

Specified by:

getURL in interface Resource

Overrides:

getURL in class ClassPathResource

Throws:

IOException - if the resource cannot be resolved as URL, i.e. if the resource is not available as a descriptor

See Also:

• ClassLoader.getResource(String)
• Class.getResource(String)

contentLength

public long contentLength()
                   throws IOException

Description copied from class: AbstractResource

This method reads the entire InputStream to determine the content length.

For a custom subclass of InputStreamResource, we strongly recommend overriding this method with a more optimal implementation, for example, checking File length, or possibly simply returning -1 if the stream can only be read once.

Specified by:

contentLength in interface Resource

Overrides:

contentLength in class AbstractFileResolvingResource

Returns:

the content length (or -1 if undetermined)

Throws:

IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)

See Also:

• InputStreamSource.getInputStream()

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: ClassPathResource

This implementation opens an InputStream for the underlying class path resource, if available.

Specified by:

getInputStream in interface InputStreamSource

Overrides:

getInputStream in class ClassPathResource

Returns:

the input stream for the underlying resource (must not be null)

Throws:

IOException - if the content stream could not be opened

See Also:

• ClassLoader.getResourceAsStream(String)
• Class.getResourceAsStream(String)
• ClassLoader.getSystemResourceAsStream(String)

consumeContent

public void consumeContent(IOConsumer<InputStream> consumer)
                    throws IOException

Description copied from interface: Resource

Process the contents of this resource through the given consumer callback.

The given consumer will be invoked a single time by default - but may also be invoked multiple times in case of a multi-content resource handle, for example returned from a getResource("classpath*:...") call. While InputStreamSource.getInputStream() returns a merged sequence of content in such a case, this method performs one callback per file content.

Parameters:

consumer - a consumer for each InputStream

Throws:

IOException - in case of general resolution/reading failures

See Also:

• InputStreamSource.getInputStream()
• ResourceLoader.CLASSPATH_ALL_URL_PREFIX

createRelative

public Resource createRelative(String relativePath)

Description copied from class: ClassPathResource

This implementation creates a ClassPathResource, applying the given path relative to the path used to create this descriptor.

Specified by:

createRelative in interface Resource

Overrides:

createRelative in class ClassPathResource

Parameters:

relativePath - the relative path (relative to this resource)

Returns:

the resource handle for the relative resource

See Also:

• StringUtils.applyRelativePath(String, String)

getDescription

public String getDescription()

Description copied from class: ClassPathResource

This implementation returns a description that includes the absolute class path location.

Specified by:

getDescription in interface Resource

Overrides:

getDescription in class ClassPathResource

See Also:

• Object.toString()