Package org.aoju.bus.core.io.resource

Interface Resource

All Known Implementing Classes:

BytesResource, CharSequenceResource, ClassPathResource, FileObjectResource, FileResource, InputStreamResource, MultiFileResource, MultiResource, StringResource, UriResource, VfsResource, WebAppResource

public interface Resource

资源接口定义 资源可以是文件、URL、ClassPath中的文件亦或者jar包中的文件

Since:

Java 17+

Author:

Kimi Liu

Method Summary

Modifier and Type	Method	Description
String	getName()	获取资源名,例如文件资源的资源名为文件名
default BufferedReader	getReader(Charset charset)	获得Reader
InputStream	getStream()	获得 InputStream
URL	getUrl()	获得解析后的URL
default boolean	isModified()	检查资源是否变更 一般用于文件类资源，检查文件是否被修改过
default byte[]	readBytes()	读取资源内容,读取完毕后会关闭流 关闭流并不影响下一次读取
default String	readString(Charset charset)	读取资源内容,读取完毕后会关闭流 关闭流并不影响下一次读取
default void	writeTo(OutputStream out)	将资源内容写出到流，不关闭输出流，但是关闭资源流

Method Details

getName

String getName()

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

Returns:

资源名

getUrl

URL getUrl()

获得解析后的URL

Returns:

解析后的URL

getStream

InputStream getStream()

获得 InputStream

Returns:

InputStream

isModified

default boolean isModified()

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

Returns:

是否变更

getReader

default BufferedReader getReader(Charset charset)

获得Reader

Parameters:

charset - 编码

Returns:

BufferedReader

readString

default String readString(Charset charset)
                   throws InternalException

读取资源内容,读取完毕后会关闭流 关闭流并不影响下一次读取

Parameters:

charset - 编码

Returns:

读取资源内容

Throws:

InternalException - 包装IOException

readBytes

default byte[] readBytes()
                  throws InternalException

读取资源内容,读取完毕后会关闭流 关闭流并不影响下一次读取

Returns:

读取资源内容

Throws:

InternalException - 包装IOException

writeTo

default void writeTo(OutputStream out)
              throws InternalException

将资源内容写出到流，不关闭输出流，但是关闭资源流

Parameters:

out - 输出流

Throws:

InternalException - IO异常