程序包 cn.taketoday.core.io

类 ClassPathResource

java.lang.Object

cn.taketoday.core.io.AbstractResource

cn.taketoday.core.io.AbstractFileResolvingResource

cn.taketoday.core.io.ClassPathResource

所有已实现的接口:

InputStreamSource, Resource, ThrowingConsumer<OutputStream>, Consumer<OutputStream>

直接已知子类:

ClassRelativeResourceLoader.ClassRelativeContextResource, DefaultResourceLoader.ClassPathContextResource

public class ClassPathResource
extends AbstractFileResolvingResource

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.

从以下版本开始:

2019-05-14 21:47

作者:

TODAY, Juergen Hoeller, Sam Brannen

另请参阅:

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

字段概要

字段

修饰符和类型	字段	说明
private final String	absolutePath
private ClassLoader	classLoader
protected Resource	delegate
private final String	path	Internal representation of the original path supplied by the user, used for creating relative paths and resolving URLs and InputStreams.
private Class<?>	resourceClass

从接口继承的字段 cn.taketoday.core.io.Resource

EMPTY_ARRAY

构造器概要

构造器

构造器	说明
ClassPathResource(String path)	Create a new ClassPathResource for ClassLoader usage.
ClassPathResource(String path, Class<?> clazz)	Create a new ClassPathResource for Class usage.
ClassPathResource(String path, ClassLoader classLoader)	Create a new ClassPathResource for ClassLoader usage.

方法概要

修饰符和类型	方法	说明
Resource	createRelative(String relativePath)	Create a resource relative to this resource.
boolean	equals(Object obj)	This implementation compares the underlying class path locations and associated class loaders.
boolean	exists()	This implementation checks for the resolution of a resource URL.
final ClassLoader	getClassLoader()	Return the ClassLoader that this resource will be obtained from.
final Resource	getDelegate()
InputStream	getInputStream()	This implementation opens an InputStream for the underlying class path resource, if available.
String	getName()	Determine the filename for this resource — typically the last part of the path — for example, "myfile.txt".
final Resource	getOriginalResource()	Get Original Resource
final String	getPath()	Return the absolute path for this resource, as a cleaned resource path within the class path.
URL	getURL()	This implementation returns a URL for the underlying class path resource, if available.
int	hashCode()	This implementation returns the hash code of the underlying class path location.
boolean	isDirectory()	Tests whether the resource denoted by this abstract pathname is a directory.
boolean	isReadable()	This implementation checks for the resolution of a resource URL upfront, then proceeding with AbstractFileResolvingResource's length check.
String[]	list()	list Resource under the directory
Resource[]	list(ResourceFilter filter)	list Resource under the directory
protected URL	resolveURL()	Resolves a URL for the underlying class path resource.
String	toString()	This implementation returns a description that includes the absolute class path location.

从类继承的方法 cn.taketoday.core.io.AbstractFileResolvingResource

checkReadable, contentLength, customizeConnection, customizeConnection, getFile, getFile, getFileForLastModifiedCheck, isFile, isFile, lastModified, readableChannel

从类继承的方法 cn.taketoday.core.io.AbstractResource

getURI, isOpen

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.util.function.Consumer

andThen

从接口继承的方法 cn.taketoday.core.io.InputStreamSource

acceptWithException, getReader, getReader, transferTo

从接口继承的方法 cn.taketoday.core.io.Resource

getContentAsByteArray, getContentAsString

从接口继承的方法 cn.taketoday.util.function.ThrowingConsumer

accept, accept, throwing

字段详细资料

path

private final String path

Internal representation of the original path supplied by the user, used for creating relative paths and resolving URLs and InputStreams.

absolutePath

private final String absolutePath

resourceClass

private Class<?> resourceClass

classLoader

private ClassLoader classLoader

delegate

protected Resource delegate

构造器详细资料

ClassPathResource

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 default class loader will be used for loading the resource.

参数:

path - the absolute path within the class path

另请参阅:

• ClassUtils.getDefaultClassLoader()

ClassPathResource

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.

If the supplied ClassLoader is null, the default class loader will be used for loading the resource.

参数:

path - the absolute path within the class path

classLoader - the class loader to load the resource with

另请参阅:

• ClassUtils.getDefaultClassLoader()

ClassPathResource

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 class path via a leading slash.

If the supplied Class is null, the default class loader will be used for loading the resource.

This is also useful for resource access within the module system, loading a resource from the containing module of a given Class. See ModuleResource and its javadoc.

参数:

path - relative or absolute path within the class path

clazz - the class to load resources with

另请参阅:

• ClassUtils.getDefaultClassLoader()
• ModuleResource

方法详细资料

getDelegate

public final Resource getDelegate()

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 a descriptor

另请参阅:

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

exists

public boolean exists()

This implementation checks for the resolution of a resource URL.

指定者:

exists 在接口中 Resource

覆盖:

exists 在类中 AbstractFileResolvingResource

另请参阅:

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

isReadable

public boolean isReadable()

This implementation checks for the resolution of a resource URL upfront, then proceeding with AbstractFileResolvingResource's length check.

指定者:

isReadable 在接口中 Resource

覆盖:

isReadable 在类中 AbstractFileResolvingResource

另请参阅:

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

getInputStream

public InputStream getInputStream()
                           throws IOException

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

返回:

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

抛出:

FileNotFoundException - if the underlying resource does not exist

IOException - if the content stream could not be opened

另请参阅:

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

resolveURL

@Nullable
protected URL resolveURL()

Resolves a URL for the underlying class path resource.

返回:

the resolved URL, or null if not resolvable

isDirectory

public boolean isDirectory()
                    throws IOException

从接口复制的说明: Resource

Tests whether the resource denoted by this abstract pathname is a directory.

Where it is required to distinguish an I/O exception from the case that the file is not a directory, or where several attributes of the same file are required at the same time, then the Files.readAttributes method may be used.

指定者:

isDirectory 在接口中 Resource

覆盖:

isDirectory 在类中 AbstractResource

返回:

true if and only if the file denoted by this abstract pathname exists and is a directory; false otherwise

抛出:

IOException - cannot determine resource

list

public Resource[] list(ResourceFilter filter)
                throws IOException

从接口复制的说明: Resource

list Resource under the directory

指定者:

list 在接口中 Resource

覆盖:

list 在类中 AbstractResource

参数:

filter - filter Resource

返回:

Resource names

抛出:

IOException - if the resource is not available

list

public String[] list()
              throws IOException

从接口复制的说明: Resource

list Resource under the directory

指定者:

list 在接口中 Resource

覆盖:

list 在类中 AbstractResource

返回:

Resource names

抛出:

IOException - if the resource is not available

getName

public String getName()

从类复制的说明: AbstractResource

Determine the filename for this resource — typically the last part of the path — for example, "myfile.txt".

Returns null if this type of resource does not have a filename.

Implementations are encouraged to return the filename unencoded.

指定者:

getName 在接口中 Resource

覆盖:

getName 在类中 AbstractResource

createRelative

public Resource createRelative(String relativePath)

从接口复制的说明: Resource

Create a resource relative to this resource.

指定者:

createRelative 在接口中 Resource

覆盖:

createRelative 在类中 AbstractResource

参数:

relativePath - the relative path (relative to this resource)

返回:

the resource handle for the relative resource

equals

public boolean equals(@Nullable
 Object obj)

This implementation compares the underlying class path locations and associated class loaders.

覆盖:

equals 在类中 AbstractResource

另请参阅:

• getPath()
• getClassLoader()

hashCode

public int hashCode()

This implementation returns the hash code of the underlying class path location.

覆盖:

hashCode 在类中 AbstractResource

另请参阅:

• getPath()

getOriginalResource

public final Resource getOriginalResource()

Get Original Resource

返回:

Original Resource

getClassLoader

@Nullable
public final ClassLoader getClassLoader()

Return the ClassLoader that this resource will be obtained from.

从以下版本开始:

4.0

getPath

public final String getPath()

Return the absolute path for this resource, as a cleaned resource path within the class path.

The path returned by this method does not have a leading slash and is suitable for use with ClassLoader.getResource(String).

从以下版本开始:

4.0

toString

public String toString()

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

指定者:

toString 在接口中 Resource

覆盖:

toString 在类中 AbstractResource

另请参阅:

• Object.toString()