类 ClassPathResource
- java.lang.Object
- org.springframework.core.io.AbstractResource
- org.springframework.core.io.AbstractFileResolvingResource
- org.springframework.core.io.ClassPathResource
- 所有已实现的接口:
InputStreamSource,Resource
public class ClassPathResource extends AbstractFileResolvingResource
Resourceimplementation for class path resources. Uses either a givenClassLoaderor a givenClassfor loading resources.Supports resolution as
java.io.Fileif the class path resource resides in the file system, but not for resources in a JAR. Always supports resolution as URL.- 从以下版本开始:
- 28.12.2003
- 作者:
- Juergen Hoeller, Sam Brannen
- 另请参阅:
ClassLoader.getResourceAsStream(String),Class.getResourceAsStream(String)
构造器概要
构造器 限定符 构造器 说明 ClassPathResource(String path)Create a newClassPathResourceforClassLoaderusage.ClassPathResource(String path, Class<?> clazz)Create a newClassPathResourceforClassusage.ClassPathResource(String path, ClassLoader classLoader)Create a newClassPathResourceforClassLoaderusage.protectedClassPathResource(String path, ClassLoader classLoader, Class<?> clazz)Create a newClassPathResourcewith optionalClassLoaderandClass.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 ResourcecreateRelative(String relativePath)This implementation creates a ClassPathResource, applying the given path relative to the path of the underlying resource of this descriptor.booleanequals(Object obj)This implementation compares the underlying class path locations.booleanexists()This implementation checks for the resolution of a resource URL.ClassLoadergetClassLoader()Return the ClassLoader that this resource will be obtained from.StringgetDescription()This implementation returns a description that includes the class path location.StringgetFilename()This implementation returns the name of the file that this class path resource refers to.InputStreamgetInputStream()This implementation opens an InputStream for the given class path resource.StringgetPath()Return the path for this resource (as resource path within the class path).URLgetURL()This implementation returns a URL for the underlying class path resource, if available.inthashCode()This implementation returns the hash code of the underlying class path location.protected URLresolveURL()Resolves a URL for the underlying class path resource.从类继承的方法 org.springframework.core.io.AbstractFileResolvingResource
contentLength, customizeConnection, customizeConnection, getFile, getFile, getFileForLastModifiedCheck, isReadable, lastModified
从类继承的方法 org.springframework.core.io.AbstractResource
getURI, isOpen, toString
构造器详细资料
ClassPathResource
public ClassPathResource(String path)
Create a newClassPathResourceforClassLoaderusage. 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.
- 参数:
path- the absolute path within the class path- 另请参阅:
ClassLoader.getResourceAsStream(String),ClassUtils.getDefaultClassLoader()
ClassPathResource
public ClassPathResource(String path, ClassLoader classLoader)
Create a newClassPathResourceforClassLoaderusage. A leading slash will be removed, as the ClassLoader resource access methods will not accept it.- 参数:
path- the absolute path within the classpathclassLoader- the class loader to load the resource with, ornullfor the thread context class loader- 另请参阅:
ClassLoader.getResourceAsStream(String)
ClassPathResource
public ClassPathResource(String path, Class<?> clazz)
Create a newClassPathResourceforClassusage. The path can be relative to the given class, or absolute within the classpath via a leading slash.- 参数:
path- relative or absolute path within the class pathclazz- the class to load resources with- 另请参阅:
Class.getResourceAsStream(java.lang.String)
ClassPathResource
protected ClassPathResource(String path, ClassLoader classLoader, Class<?> clazz)
Create a newClassPathResourcewith optionalClassLoaderandClass. Only for internal usage.- 参数:
path- relative or absolute path within the classpathclassLoader- the class loader to load the resource with, if anyclazz- the class to load resources with, if any
方法详细资料
getPath
public final String getPath()
Return the path for this resource (as resource path within the class path).
getClassLoader
public final ClassLoader getClassLoader()
Return the ClassLoader that this resource will be obtained from.
exists
public boolean exists()
This implementation checks for the resolution of a resource URL.
resolveURL
protected URL resolveURL()
Resolves a URL for the underlying class path resource.- 返回:
- the resolved URL, or
nullif not resolvable
getInputStream
public InputStream getInputStream() throws IOException
This implementation opens an InputStream for the given class path resource.- 返回:
- the input stream for the underlying resource (must not be
null) - 抛出:
FileNotFoundException- if the underlying resource doesn't existIOException- if the content stream could not be opened- 另请参阅:
ClassLoader.getResourceAsStream(String),Class.getResourceAsStream(String)
getURL
public URL getURL() throws IOException
This implementation returns a URL for the underlying class path resource, if available.- 指定者:
getURL在接口中Resource- 覆盖:
getURL在类中AbstractResource- 抛出:
IOException- if the resource cannot be resolved as URL, i.e. if the resource is not available as descriptor- 另请参阅:
ClassLoader.getResource(String),Class.getResource(String)
createRelative
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.- 指定者:
createRelative在接口中Resource- 覆盖:
createRelative在类中AbstractResource- 参数:
relativePath- the relative path (relative to this resource)- 返回:
- the resource handle for the relative resource
- 另请参阅:
StringUtils.applyRelativePath(String, String)
getFilename
public String getFilename()
This implementation returns the name of the file that this class path resource refers to.- 指定者:
getFilename在接口中Resource- 覆盖:
getFilename在类中AbstractResource- 另请参阅:
StringUtils.getFilename(String)
getDescription
public String getDescription()
This implementation returns a description that includes the class path location.- 另请参阅:
Object.toString()
equals
public boolean equals(Object obj)
This implementation compares the underlying class path locations.- 覆盖:
equals在类中AbstractResource- 另请参阅:
Resource.getDescription()
hashCode
public int hashCode()
This implementation returns the hash code of the underlying class path location.- 覆盖:
hashCode在类中AbstractResource- 另请参阅:
Resource.getDescription()