ByteArrayDataSink


@UnstableApi
class ByteArrayDataSink : DataSink


A DataSink for writing to a byte array.

Summary

Public constructors

Public functions

Unit

Closes the sink.

ByteArray<Byte>?

Returns the data written to the sink since the last call to open, or null if open has never been called.

Unit
open(dataSpec: DataSpec!)

Opens the sink to consume the specified data.

Unit
write(buffer: ByteArray!, offset: Int, length: Int)

Consumes the provided data.

Public constructors

ByteArrayDataSink

ByteArrayDataSink()

Public functions

close

fun close(): Unit

Closes the sink.

Note: This method must be called even if the corresponding call to open threw an IOException. See open for more details.

Throws
java.io.IOException

If an error occurs closing the sink.

getData

fun getData(): ByteArray<Byte>?

Returns the data written to the sink since the last call to open, or null if open has never been called.

open

fun open(dataSpec: DataSpec!): Unit

Opens the sink to consume the specified data.

Note: If an IOException is thrown, callers must still call close to ensure that any partial effects of the invocation are cleaned up.

Parameters
dataSpec: DataSpec!

Defines the data to be consumed.

Throws
java.io.IOException

If an error occurs opening the sink.

write

fun write(buffer: ByteArray!, offset: Int, length: Int): Unit

Consumes the provided data.

Parameters
buffer: ByteArray!

The buffer from which data should be consumed.

offset: Int

The offset of the data to consume in buffer.

length: Int

The length of the data to consume, in bytes.

Throws
java.io.IOException

If an error occurs writing to the sink.