Class TestContextResourceUtils
- java.lang.Object
- org.springframework.test.context.util.TestContextResourceUtils
public abstract class TestContextResourceUtils extends Object
Utility methods for working with resources within the Spring TestContext Framework. Mainly for internal use within the framework.- Since:
- 4.1
- Author:
- Sam Brannen, Tadaya Tsuyukubo
- See Also:
ResourceUtils
,Resource
,ClassPathResource
,FileSystemResource
,UrlResource
,ResourceLoader
Constructor Summary
Constructors Constructor Description TestContextResourceUtils()
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static String[]
convertToClasspathResourcePaths(Class<?> clazz, boolean preservePlaceholders, String... paths)
Convert the supplied paths to classpath resource paths.static String[]
convertToClasspathResourcePaths(Class<?> clazz, String... paths)
Convert the supplied paths to classpath resource paths.static List<Resource>
convertToResourceList(ResourceLoader resourceLoader, String... paths)
Convert the supplied paths to a list ofResource
handles using the givenResourceLoader
.static Resource[]
convertToResources(ResourceLoader resourceLoader, String... paths)
Convert the supplied paths to an array ofResource
handles using the givenResourceLoader
.
Constructor Detail
TestContextResourceUtils
public TestContextResourceUtils()
Method Detail
convertToClasspathResourcePaths
public static String[] convertToClasspathResourcePaths(Class<?> clazz, String... paths)
Convert the supplied paths to classpath resource paths.Delegates to
convertToClasspathResourcePaths(Class, boolean, String...)
withfalse
supplied for thepreservePlaceholders
flag.- Parameters:
clazz
- the class with which the paths are associatedpaths
- the paths to be converted- Returns:
- a new array of converted resource paths
- See Also:
convertToResources(org.springframework.core.io.ResourceLoader, java.lang.String...)
convertToClasspathResourcePaths
public static String[] convertToClasspathResourcePaths(Class<?> clazz, boolean preservePlaceholders, String... paths)
Convert the supplied paths to classpath resource paths.For each of the supplied paths:
- A plain path — for example,
"context.xml"
— will be treated as a classpath resource that is relative to the package in which the specified class is defined. Such a path will be prepended with theclasspath:
prefix and the path to the package for the class. - A path starting with a slash will be treated as an absolute path within the classpath, for example:
"/org/example/schema.sql"
. Such a path will be prepended with theclasspath:
prefix. - A path which is already prefixed with a URL protocol (e.g.,
classpath:
,file:
,http:
, etc.) will not have its protocol modified.
Each path will then be cleaned, unless the
preservePlaceholders
flag istrue
and the path contains one or more placeholders in the form${placeholder.name}
.- Parameters:
clazz
- the class with which the paths are associatedpreservePlaceholders
-true
if placeholders should be preservedpaths
- the paths to be converted- Returns:
- a new array of converted resource paths
- Since:
- 5.2
- See Also:
convertToResources(org.springframework.core.io.ResourceLoader, java.lang.String...)
,ResourceUtils.CLASSPATH_URL_PREFIX
,ResourceUtils.FILE_URL_PREFIX
- A plain path — for example,
convertToResources
public static Resource[] convertToResources(ResourceLoader resourceLoader, String... paths)
Convert the supplied paths to an array ofResource
handles using the givenResourceLoader
.- Parameters:
resourceLoader
- theResourceLoader
to use to convert the pathspaths
- the paths to be converted- Returns:
- a new array of resources
- See Also:
convertToResourceList(ResourceLoader, String...)
,convertToClasspathResourcePaths(java.lang.Class<?>, java.lang.String...)
convertToResourceList
public static List<Resource> convertToResourceList(ResourceLoader resourceLoader, String... paths)
Convert the supplied paths to a list ofResource
handles using the givenResourceLoader
.- Parameters:
resourceLoader
- theResourceLoader
to use to convert the pathspaths
- the paths to be converted- Returns:
- a new list of resources
- Since:
- 4.2
- See Also:
convertToResources(ResourceLoader, String...)
,convertToClasspathResourcePaths(java.lang.Class<?>, java.lang.String...)