Module bus.core

Package org.miaixz.bus.core.io.sink

Class RealSink

java.lang.Object

org.miaixz.bus.core.io.sink.RealSink

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Channel, WritableByteChannel, BufferSink, Sink

public final class RealSink
extends Object
implements BufferSink

实现缓冲接收器，管理字节流的写入操作，支持多种数据格式的写入并适配底层接收器。

Since:

Java 17+

Author:

Kimi Liu

Field Summary

Fields

Modifier and Type	Field	Description
final Buffer	buffer	内部缓冲区
final Sink	sink	底层接收器

Constructor Summary

Constructors

Constructor	Description
RealSink(Sink sink)	构造方法，初始化接收器。

Method Summary

Modifier and Type	Method	Description
Buffer	buffer()	获取内部缓冲区。
void	close()	关闭接收器，释放资源。
BufferSink	emit()	将所有缓冲数据写入底层接收器。
BufferSink	emitCompleteSegments()	将完整的缓冲段写入底层接收器。
void	flush()	刷新缓冲区，将所有数据写入底层接收器。
boolean	isOpen()	检查接收器是否打开。
OutputStream	outputStream()	获取适配此接收器的输出流。
Timeout	timeout()	获取底层接收器的超时配置。
String	toString()	返回对象的字符串表示。
BufferSink	write(byte[] source)	写入字节数组。
BufferSink	write(byte[] source, int offset, int byteCount)	写入字节数组的指定部分。
int	write(ByteBuffer source)	从 ByteBuffer 写入数据。
void	write(Buffer source, long byteCount)	从源缓冲区写入指定字节数。
BufferSink	write(ByteString byteString)	写入字节字符串。
BufferSink	write(Source source, long byteCount)	从源读取指定字节数并写入接收器。
long	writeAll(Source source)	从源读取所有数据并写入接收器。
BufferSink	writeByte(int b)	写入单个字节。
BufferSink	writeDecimalLong(long v)	以十进制形式写入长整型。
BufferSink	writeHexadecimalUnsignedLong(long v)	以十六进制形式写入无符号长整型。
BufferSink	writeInt(int i)	使用大端序写入整型。
BufferSink	writeIntLe(int i)	使用小端序写入整型。
BufferSink	writeLong(long v)	使用大端序写入长整型。
BufferSink	writeLongLe(long v)	使用小端序写入长整型。
BufferSink	writeShort(int s)	使用大端序写入短整型。
BufferSink	writeShortLe(int s)	使用小端序写入短整型。
BufferSink	writeString(String string, int beginIndex, int endIndex, Charset charset)	使用指定字符集编码写入字符串的指定部分。
BufferSink	writeString(String string, Charset charset)	使用指定字符集编码写入字符串。
BufferSink	writeUtf8(String string)	使用 UTF-8 编码写入字符串。
BufferSink	writeUtf8(String string, int beginIndex, int endIndex)	使用 UTF-8 编码写入字符串的指定部分。
BufferSink	writeUtf8CodePoint(int codePoint)	使用 UTF-8 编码写入 Unicode 码点。

Methods inherited from class java.lang.Object

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

Field Details

buffer

public final Buffer buffer

内部缓冲区

sink

public final Sink sink

底层接收器

Constructor Details

RealSink

public RealSink(Sink sink)

构造方法，初始化接收器。

Parameters:

sink - 底层接收器

Throws:

NullPointerException - 如果 sink 为 null

Method Details

buffer

public Buffer buffer()

获取内部缓冲区。

Specified by:

buffer in interface BufferSink

Returns:

内部缓冲区

write

public void write(Buffer source,
 long byteCount)
           throws IOException

从源缓冲区写入指定字节数。

Specified by:

write in interface Sink

Parameters:

source - 数据源缓冲区

byteCount - 要写入的字节数

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

write

public BufferSink write(ByteString byteString)
                 throws IOException

写入字节字符串。

Specified by:

write in interface BufferSink

Parameters:

byteString - 字节字符串

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeUtf8

public BufferSink writeUtf8(String string)
                     throws IOException

使用 UTF-8 编码写入字符串。

Specified by:

writeUtf8 in interface BufferSink

Parameters:

string - 输入字符串

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeUtf8

public BufferSink writeUtf8(String string,
 int beginIndex,
 int endIndex)
                     throws IOException

使用 UTF-8 编码写入字符串的指定部分。

Specified by:

writeUtf8 in interface BufferSink

Parameters:

string - 输入字符串

beginIndex - 起始索引

endIndex - 结束索引

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeUtf8CodePoint

public BufferSink writeUtf8CodePoint(int codePoint)
                              throws IOException

使用 UTF-8 编码写入 Unicode 码点。

Specified by:

writeUtf8CodePoint in interface BufferSink

Parameters:

codePoint - Unicode 码点

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeString

public BufferSink writeString(String string,
 Charset charset)
                       throws IOException

使用指定字符集编码写入字符串。

Specified by:

writeString in interface BufferSink

Parameters:

string - 输入字符串

charset - 字符集

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeString

public BufferSink writeString(String string,
 int beginIndex,
 int endIndex,
 Charset charset)
                       throws IOException

使用指定字符集编码写入字符串的指定部分。

Specified by:

writeString in interface BufferSink

Parameters:

string - 输入字符串

beginIndex - 起始索引

endIndex - 结束索引

charset - 字符集

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

write

public BufferSink write(byte[] source)
                 throws IOException

写入字节数组。

Specified by:

write in interface BufferSink

Parameters:

source - 字节数组

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

write

public BufferSink write(byte[] source,
 int offset,
 int byteCount)
                 throws IOException

写入字节数组的指定部分。

Specified by:

write in interface BufferSink

Parameters:

source - 字节数组

offset - 起始偏移量

byteCount - 写入字节数

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

write

public int write(ByteBuffer source)
          throws IOException

从 ByteBuffer 写入数据。

Specified by:

write in interface WritableByteChannel

Parameters:

source - 数据源 ByteBuffer

Returns:

写入的字节数

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeAll

public long writeAll(Source source)
              throws IOException

从源读取所有数据并写入接收器。

Specified by:

writeAll in interface BufferSink

Parameters:

source - 数据源

Returns:

读取的总字节数

Throws:

IOException - 如果读取或写入失败

IllegalArgumentException - 如果 source 为 null

write

public BufferSink write(Source source,
 long byteCount)
                 throws IOException

从源读取指定字节数并写入接收器。

Specified by:

write in interface BufferSink

Parameters:

source - 数据源

byteCount - 要读取的字节数

Returns:

当前接收器

Throws:

IOException - 如果读取或写入失败

EOFException - 如果源数据不足

writeByte

public BufferSink writeByte(int b)
                     throws IOException

写入单个字节。

Specified by:

writeByte in interface BufferSink

Parameters:

b - 字节值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeShort

public BufferSink writeShort(int s)
                      throws IOException

使用大端序写入短整型。

Specified by:

writeShort in interface BufferSink

Parameters:

s - 短整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeShortLe

public BufferSink writeShortLe(int s)
                        throws IOException

使用小端序写入短整型。

Specified by:

writeShortLe in interface BufferSink

Parameters:

s - 短整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeInt

public BufferSink writeInt(int i)
                    throws IOException

使用大端序写入整型。

Specified by:

writeInt in interface BufferSink

Parameters:

i - 整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeIntLe

public BufferSink writeIntLe(int i)
                      throws IOException

使用小端序写入整型。

Specified by:

writeIntLe in interface BufferSink

Parameters:

i - 整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeLong

public BufferSink writeLong(long v)
                     throws IOException

使用大端序写入长整型。

Specified by:

writeLong in interface BufferSink

Parameters:

v - 长整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeLongLe

public BufferSink writeLongLe(long v)
                       throws IOException

使用小端序写入长整型。

Specified by:

writeLongLe in interface BufferSink

Parameters:

v - 长整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeDecimalLong

public BufferSink writeDecimalLong(long v)
                            throws IOException

以十进制形式写入长整型。

Specified by:

writeDecimalLong in interface BufferSink

Parameters:

v - 长整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

writeHexadecimalUnsignedLong

public BufferSink writeHexadecimalUnsignedLong(long v)
                                        throws IOException

以十六进制形式写入无符号长整型。

Specified by:

writeHexadecimalUnsignedLong in interface BufferSink

Parameters:

v - 长整型值

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

emitCompleteSegments

public BufferSink emitCompleteSegments()
                                throws IOException

将完整的缓冲段写入底层接收器。

Specified by:

emitCompleteSegments in interface BufferSink

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

emit

public BufferSink emit()
                throws IOException

将所有缓冲数据写入底层接收器。

Specified by:

emit in interface BufferSink

Returns:

当前接收器

Throws:

IOException - 如果写入失败

IllegalStateException - 如果接收器已关闭

outputStream

public OutputStream outputStream()

获取适配此接收器的输出流。

Specified by:

outputStream in interface BufferSink

Returns:

输出流

flush

public void flush()
           throws IOException

刷新缓冲区，将所有数据写入底层接收器。

Specified by:

flush in interface BufferSink

Specified by:

flush in interface Flushable

Specified by:

flush in interface Sink

Throws:

IOException - 如果刷新失败

IllegalStateException - 如果接收器已关闭

isOpen

public boolean isOpen()

检查接收器是否打开。

Specified by:

isOpen in interface Channel

Returns:

是否打开

close

public void close()

关闭接收器，释放资源。

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Specified by:

close in interface Sink

timeout

public Timeout timeout()

获取底层接收器的超时配置。

Specified by:

timeout in interface Sink

Returns:

超时对象

toString

public String toString()

返回对象的字符串表示。

Overrides:

toString in class Object

Returns:

字符串表示，包含底层接收器信息