Class SpecialCloseByteSupplier

java.lang.Object

cool.scx.io.supplier.SpecialCloseByteSupplier

All Implemented Interfaces:

ByteSupplier, AutoCloseable

public final class SpecialCloseByteSupplier
extends Object
implements ByteSupplier

SpecialCloseByteSupplier

具有特殊 close 行为的 ByteSupplier 包装器.

Version:

0.0.1

Author:

scx567888

Method Summary

Modifier and Type	Method	Description
ByteSupplier	byteSupplier()
void	close()	如果持有底层资源, 在此方法释放资源
ByteChunk	get()	获取下一个数据块
static SpecialCloseByteSupplier	noClose(ByteSupplier byteSupplier)
static SpecialCloseByteSupplier	noCloseDrain(ByteSupplier byteSupplier)
static SpecialCloseByteSupplier	singleClose(ByteSupplier byteSupplier)
static SpecialCloseByteSupplier	singleCloseDrain(ByteSupplier byteSupplier)

Methods inherited from class Object

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

Method Details

noClose

public static SpecialCloseByteSupplier noClose(ByteSupplier byteSupplier)

singleClose

public static SpecialCloseByteSupplier singleClose(ByteSupplier byteSupplier)

noCloseDrain

public static SpecialCloseByteSupplier noCloseDrain(ByteSupplier byteSupplier)

singleCloseDrain

public static SpecialCloseByteSupplier singleCloseDrain(ByteSupplier byteSupplier)

get

public ByteChunk get()
              throws Exception

Description copied from interface: ByteSupplier

获取下一个数据块

• 必须是推进式的阻塞拉取
• 如果当前已经读取到有效数据 -> 返回 ByteChunk(len > 0)
• 如果暂时无法输出数据, 但 I/O 状态确实推进了 -> 返回 EMPTY_BYTE_CHUNK
• 如果 EOF 且不会再产生数据 -> 返回 null
• 不允许无状态的空循环: 供应者不得无意义地连续返回 EMPTY_BYTE_CHUNK
• 连续多次调用 get() 必须使底层数据源或解码状态单调推进

Specified by:

get in interface ByteSupplier

Returns:

ByteChunk.

Throws:

Exception - 数据获取过程中发生的任何异常.

close

public void close()
           throws Exception

Description copied from interface: ByteSupplier

如果持有底层资源, 在此方法释放资源

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ByteSupplier

Throws:

Exception

byteSupplier

public ByteSupplier byteSupplier()