| java.lang.Object | |||
| ↳ | org.springframework.core.io.AbstractResource | ||
| ↳ | org.springframework.core.io.AbstractFileResolvingResource | ||
| ↳ | org.springframework.core.io.ClassPathResource | ||
Class Overview
Resource implementation for class path resources.
Uses either a given ClassLoader or a given Class for loading resources.
Supports resolution as java.io.File if the class path
resource resides in the file system, but not for resources in a JAR.
Always supports resolution as URL.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Create a new ClassPathResource for ClassLoader usage.
| |||||||||||
Create a new ClassPathResource for ClassLoader usage.
| |||||||||||
Create a new ClassPathResource for Class usage.
| |||||||||||
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Create a new ClassPathResource with optional ClassLoader and Class.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This implementation creates a ClassPathResource, applying the given path
relative to the path of the underlying resource of this descriptor.
| |||||||||||
This implementation compares the underlying class path locations.
| |||||||||||
This implementation checks for the resolution of a resource URL.
| |||||||||||
Return the ClassLoader that this resource will be obtained from.
| |||||||||||
This implementation returns a description that includes the class path location.
| |||||||||||
This implementation returns the name of the file that this class path
resource refers to.
| |||||||||||
This implementation opens an InputStream for the given class path resource.
| |||||||||||
Return the path for this resource (as resource path within the class path).
| |||||||||||
This implementation returns a URL for the underlying class path resource.
| |||||||||||
This implementation returns the hash code of the underlying
class path location.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.core.io.AbstractFileResolvingResource
| |||||||||||
|
From class
org.springframework.core.io.AbstractResource
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
org.springframework.core.io.InputStreamSource
| |||||||||||
|
From interface
org.springframework.core.io.Resource
| |||||||||||
Public Constructors
public ClassPathResource (String path)
Create a new ClassPathResource for ClassLoader usage. A leading slash will be removed, as the ClassLoader resource access methods will not accept it.
The thread context class loader will be used for loading the resource.
Parameters
| path | the absolute path within the class path |
|---|
public ClassPathResource (String path, ClassLoader classLoader)
Create a new ClassPathResource for ClassLoader usage. A leading slash will be removed, as the ClassLoader resource access methods will not accept it.
Parameters
| path | the absolute path within the classpath |
|---|---|
| classLoader | the class loader to load the resource with,
or null for the thread context class loader |
See Also
public ClassPathResource (String path, Class<?> clazz)
Create a new ClassPathResource for Class usage. The path can be relative to the given class, or absolute within the classpath via a leading slash.
Parameters
| path | relative or absolute path within the class path |
|---|---|
| clazz | the class to load resources with |
See Also
Protected Constructors
protected ClassPathResource (String path, ClassLoader classLoader, Class<?> clazz)
Create a new ClassPathResource with optional ClassLoader and Class. Only for internal usage.
Parameters
| path | relative or absolute path within the classpath |
|---|---|
| classLoader | the class loader to load the resource with, if any |
| clazz | the class to load resources with, if any |
Public Methods
public Resource createRelative (String relativePath)
This implementation creates a ClassPathResource, applying the given path relative to the path of the underlying resource of this descriptor.
Parameters
| relativePath | the relative path (relative to this resource) |
|---|
Returns
- the resource handle for the relative resource
See Also
public boolean equals (Object obj)
This implementation compares the underlying class path locations.
public boolean exists ()
This implementation checks for the resolution of a resource URL.
public final ClassLoader getClassLoader ()
Return the ClassLoader that this resource will be obtained from.
public String getDescription ()
This implementation returns a description that includes the class path location.
public String getFilename ()
This implementation returns the name of the file that this class path resource refers to.
See Also
public InputStream getInputStream ()
This implementation opens an InputStream for the given class path resource.
Throws
| IOException |
|---|
public final String getPath ()
Return the path for this resource (as resource path within the class path).
public URL getURL ()
This implementation returns a URL for the underlying class path resource.
Throws
| IOException |
|---|
public int hashCode ()
This implementation returns the hash code of the underlying class path location.