org.aoju.bus.core.io

Interface Source

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

BufferedSource

All Known Implementing Classes:

Buffer, ForwardingSource, GzipSource, HashingSource, InflaterSource, RealBufferedSource

public interface Source
extends Closeable

提供一个字节流。使用此接口从任何地方读取数据 它的位置:来自网络、存储或内存中的缓冲区。来源可能 分层以转换提供的数据，例如解压、解密或 移除协议框架。

Interop with InputStream

BufferedSource.inputStream() to adapt a source to an InputStream.

Since:

JDK 1.8

Version:

3.0.0

Author:

Kimi Liu

Method Summary

Modifier and Type	Method and Description
void	close() Closes this source and releases the resources held by this source.
long	read(Buffer sink, long byteCount) Removes at least 1, and up to byteCount bytes from this and appends them to sink.
Timeout	timeout() Returns the timeout for this source.

Method Detail

read

long read(Buffer sink,
          long byteCount)
   throws IOException

Removes at least 1, and up to byteCount bytes from this and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

Parameters:

sink - Buffer

byteCount - long

Returns:

the long

Throws:

IOException - IOException IOException.

timeout

Timeout timeout()

Returns the timeout for this source.

Returns:

the Timeout

close

void close()
    throws IOException

Closes this source and releases the resources held by this source. It is an error to read a closed source. It is safe to close a source more than once.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - IOException IOException.