程序包 cn.taketoday.core.io

接口 InputStreamSource

所有已知子接口:

ContextResource, Resource, WritableResource

所有已知实现类:

AbstractFileResolvingResource, AbstractResource, AppendableConsumerInputStreamSource, ByteArrayResource, ClassPathResource, ClassRelativeResourceLoader.ClassRelativeContextResource, DefaultResourceLoader.ClassPathContextResource, DescriptiveResource, EncodedResource, FileSystemResource, FileSystemResourceLoader.FileSystemContextResource, FileUrlResource, InputStreamResource, ModuleResource, PathResource, ResourceDecorator, UrlResource, WritableResourceDecorator

函数接口:

这是一个函数接口, 因此可用作 lambda 表达式或方法引用的赋值目标。

@FunctionalInterface
public interface InputStreamSource

Simple interface for objects that are sources for an InputStream.

This is the base interface for Infra more extensive Resource interface.

For single-use streams, InputStreamResource can be used for any given InputStream. Infra ByteArrayResource or any file-based Resource implementation can be used as a concrete instance, allowing one to read the underlying content stream multiple times. This makes this interface useful as an abstract content source for mail attachments, for example.

从以下版本开始:

2.1.6 2019-07-08 00:12

作者:

Juergen Hoeller, Harry Yang

另请参阅:

• InputStream
• Resource
• InputStreamResource
• ByteArrayResource

方法概要

修饰符和类型	方法	说明
InputStream	getInputStream()	Return an InputStream for the content of an underlying resource.
default Reader	getReader()	Get Reader
default Reader	getReader(String encoding)	Get Reader
default ReadableByteChannel	readableChannel()	Return a ReadableByteChannel.

方法详细资料

getInputStream

InputStream getInputStream()
                    throws IOException

Return an InputStream for the content of an underlying resource.

It is expected that each call creates a fresh stream.

This requirement is particularly important when you consider an API such as JavaMail, which needs to be able to read the stream multiple times when creating mail attachments. For such a use case, it is required that each getInputStream() call returns a fresh stream.

返回:

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

另请参阅:

• Resource.isReadable()

getReader

default Reader getReader()
                  throws IOException

Get Reader

抛出:

IOException - If an input exception occurs

getReader

default Reader getReader(String encoding)
                  throws IOException

Get Reader

参数:

encoding - Charset string

抛出:

IOException - If an input exception occurs

readableChannel

default ReadableByteChannel readableChannel()
                                     throws IOException

Return a ReadableByteChannel.

It is expected that each call creates a fresh channel.

The default implementation returns Channels.newChannel(InputStream) with the result of getInputStream().

返回:

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

另请参阅:

• getInputStream()