程序包 cn.taketoday.core.io

类 FileUrlResource

java.lang.Object

cn.taketoday.core.io.AbstractResource

cn.taketoday.core.io.AbstractFileResolvingResource

cn.taketoday.core.io.UrlResource

cn.taketoday.core.io.FileUrlResource

所有已实现的接口:

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

public class FileUrlResource
extends UrlResource
implements WritableResource

Subclass of UrlResource which assumes file resolution, to the degree of implementing the WritableResource interface for it. This resource variant also caches resolved File handles from getFile().

This is the class resolved by DefaultResourceLoader for a "file:..." URL location, allowing a downcast to WritableResource for it.

Alternatively, for direct construction from a File handle or NIO Path, consider using FileSystemResource.

从以下版本开始:

4.0 2021/12/30 21:39

作者:

Juergen Hoeller, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private File	file

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

EMPTY_ARRAY

构造器概要

构造器

构造器	说明
FileUrlResource(String location)	Create a new FileUrlResource based on the given file location, using the URL protocol "file".
FileUrlResource(URL url)	Create a new FileUrlResource based on the given URL object.

方法概要

修饰符和类型	方法	说明
FileUrlResource	createRelative(String relativePath)	This implementation creates a UrlResource, delegating to UrlResource.createRelativeURL(String) for adapting the relative path.
File	getFile()	This implementation returns a File reference for the underlying URL/URI, provided that it refers to a file in the file system.
OutputStream	getOutputStream()	Return an OutputStream for the underlying resource, allowing to (over-)write its content.
boolean	isDirectory()	Tests whether the resource denoted by this abstract pathname is a directory.
boolean	isWritable()	Indicate whether the contents of this resource can be written via OutputStreamSource.getOutputStream().
WritableByteChannel	writableChannel()	Return a WritableByteChannel.

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

createRelativeURL, customizeConnection, equals, from, from, getInputStream, getName, getURI, getURL, hashCode, isFile, toString

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

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

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

isOpen, list, list

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

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

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

andThen

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

acceptWithException, getInputStream, getReader, getReader, readableChannel, transferTo

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

getWriter

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

contentLength, exists, getContentAsByteArray, getContentAsString, getName, getURI, getURL, isFile, isOpen, isReadable, lastModified, list, list, toString

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

accept, accept, throwing

字段详细资料

file

@Nullable
private volatile File file

构造器详细资料

FileUrlResource

public FileUrlResource(URL url)

Create a new FileUrlResource based on the given URL object.

Note that this does not enforce "file" as URL protocol. If a protocol is known to be resolvable to a file, it is acceptable for this purpose.

参数:

url - a URL

另请参阅:

• ResourceUtils.isFileURL(URL)
• getFile()

FileUrlResource

public FileUrlResource(String location)
                throws MalformedURLException

Create a new FileUrlResource based on the given file location, using the URL protocol "file".

The given parts will automatically get encoded if necessary.

参数:

location - the location (i.e. the file path within that protocol)

抛出:

MalformedURLException - if the given URL specification is not valid

另请参阅:

• UrlResource(String, String)
• ResourceUtils.URL_PROTOCOL_FILE

方法详细资料

getFile

public File getFile()
             throws IOException

从类复制的说明: UrlResource

This implementation returns a File reference for the underlying URL/URI, provided that it refers to a file in the file system.

指定者:

getFile 在接口中 Resource

覆盖:

getFile 在类中 UrlResource

抛出:

FileNotFoundException - if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file system

IOException - in case of general resolution/reading failures

另请参阅:

• ResourceUtils.getFile(java.net.URL, String)

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

isWritable

public boolean isWritable()

从接口复制的说明: WritableResource

Indicate whether the contents of this resource can be written via OutputStreamSource.getOutputStream().

Will be true for typical resource descriptors; note that actual content writing may still fail when attempted. However, a value of false is a definitive indication that the resource content cannot be modified.

指定者:

isWritable 在接口中 WritableResource

另请参阅:

• OutputStreamSource.getOutputStream()
• Resource.isReadable()

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

从接口复制的说明: OutputStreamSource

Return an OutputStream for the underlying resource, allowing to (over-)write its content.

指定者:

getOutputStream 在接口中 OutputStreamSource

抛出:

IOException - if the stream could not be opened

writableChannel

public WritableByteChannel writableChannel()
                                    throws IOException

从接口复制的说明: OutputStreamSource

Return a WritableByteChannel.

It is expected that each call creates a fresh channel.

The default implementation returns Channels.newChannel(OutputStream) with the result of OutputStreamSource.getOutputStream().

指定者:

writableChannel 在接口中 OutputStreamSource

返回:

the byte channel for the underlying resource (must not be null)

抛出:

FileNotFoundException - if the underlying resource doesn't exist

IOException - if the content channel could not be opened

另请参阅:

• OutputStreamSource.getOutputStream()

createRelative

public FileUrlResource createRelative(String relativePath)
                               throws MalformedURLException

从类复制的说明: UrlResource

This implementation creates a UrlResource, delegating to UrlResource.createRelativeURL(String) for adapting the relative path.

指定者:

createRelative 在接口中 Resource

覆盖:

createRelative 在类中 UrlResource

参数:

relativePath - the relative path (relative to this resource)

返回:

the resource handle for the relative resource

抛出:

MalformedURLException

另请参阅:

• UrlResource.createRelativeURL(String)