org.dromara.hutool.core.io.resource

Class FileResource

java.lang.Object

org.dromara.hutool.core.io.resource.FileResource

All Implemented Interfaces:

Serializable, Resource

Direct Known Subclasses:

WebAppResource

public class FileResource
extends Object
implements Resource, Serializable

文件资源访问对象，支持Path 和 File 访问

Author:

looly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileResource(File file) 构造，文件名使用文件本身的名字，带扩展名
FileResource(File file, String fileName) 构造
FileResource(Path path) 构造，文件名使用文件本身的名字，带扩展名
FileResource(String path) 构造

Method Summary

Modifier and Type	Method and Description
File	getFile() 获取文件
String	getName() 获取资源名，例如文件资源的资源名为文件名
InputStream	getStream() 获得 InputStream
URL	getUrl() 获得解析后的URL，无对应URL的返回null
boolean	isModified() 检查资源是否变更 一般用于文件类资源，检查文件是否被修改过。
long	size() 获取资源大小
String	toString() 返回路径

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dromara.hutool.core.io.resource.Resource

getReader, readBytes, readStr, readUtf8Str, writeTo

Constructor Detail

FileResource

public FileResource(String path)

构造

Parameters:

path - 文件绝对路径或相对ClassPath路径，但是这个路径不能指向一个jar包中的文件

FileResource

public FileResource(Path path)

构造，文件名使用文件本身的名字，带扩展名

Parameters:

path - 文件

Since:

4.4.1

FileResource

public FileResource(File file)

构造，文件名使用文件本身的名字，带扩展名

Parameters:

file - 文件

FileResource

public FileResource(File file,
                    String fileName)

构造

Parameters:

file - 文件

fileName - 文件名，带扩展名，如果为null获取文件本身的文件名

Method Detail

getName

public String getName()

Description copied from interface: Resource

获取资源名，例如文件资源的资源名为文件名

Specified by:

getName in interface Resource

Returns:

资源名

getUrl

public URL getUrl()

Description copied from interface: Resource

获得解析后的URL，无对应URL的返回null

Specified by:

getUrl in interface Resource

Returns:

解析后的URL

size

public long size()

Description copied from interface: Resource

获取资源大小

Specified by:

size in interface Resource

Returns:

资源大小

getStream

public InputStream getStream()
                      throws NoResourceException

Description copied from interface: Resource

获得 InputStream

Specified by:

getStream in interface Resource

Returns:

InputStream

Throws:

NoResourceException

getFile

public File getFile()

获取文件

Returns:

文件

isModified

public boolean isModified()

Description copied from interface: Resource

检查资源是否变更
一般用于文件类资源，检查文件是否被修改过。

Specified by:

isModified in interface Resource

Returns:

是否变更

toString

public String toString()

返回路径

Overrides:

toString in class Object

Returns:

返回URL路径