org.aoju.bus.core.io.resource

Interface Resource

All Known Implementing Classes:

BytesResource, ClassPathResource, FileResource, InputStreamResource, MultiFileResource, MultiResource, StringResource, UriResource, WebAppResource

public interface Resource

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

Since:

JDK 1.8+

Version:

6.0.2

Author:

Kimi Liu

Method Summary

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

Method Detail

getName

String getName()

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

Returns:

资源名

getUrl

URL getUrl()

获得解析后的URL

Returns:

解析后的URL

getStream

InputStream getStream()

获得 InputStream

Returns:

InputStream

getReader

BufferedReader getReader(Charset charset)

获得Reader

Parameters:

charset - 编码

Returns:

BufferedReader

readString

String readString(Charset charset)
           throws InstrumentException

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

Parameters:

charset - 编码

Returns:

读取资源内容

Throws:

InstrumentException - 包装IOException

readBytes

byte[] readBytes()
          throws InstrumentException

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

Returns:

读取资源内容

Throws:

InstrumentException - 包装IOException

writeTo

default void writeTo(OutputStream out)
              throws InstrumentException

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

Parameters:

out - 输出流

Throws:

InstrumentException - IO异常