se.l4.commons.io

Interface Bytes

All Known Implementing Classes:

BytesOverByteArray, InputStreamBytes

public interface Bytes

Representation of a stream of bytes that can be opened.

Author:

Andreas Holstenson

Method Summary

Modifier and Type	Method and Description
default void	asChunks(ByteArrayConsumer consumer) Stream this instance to the given consumer.
default void	asChunks(int size, ByteArrayConsumer consumer) Stream this instance to the given consumer with a specific chunk size.
default ExtendedDataInput	asDataInput() Open this instance as a ExtendedDataInput.
InputStream	asInputStream() Open an InputStream for this instance.
static BytesBuilder	create()
static Bytes	create(byte[] byteArray) Create an instance for the given array of bytes.
static Bytes	create(IoSupplier<InputStream> stream) Create an instance over the given input stream.
static Bytes	empty() Get an instance that represents no data.
static Bytes	lazyViaDataOutput(IoConsumer<ExtendedDataOutput> creator) Create an instance that will create data on demand.
static Bytes	lazyViaDataOutput(IoConsumer<ExtendedDataOutput> creator, int expectedSize) Create an instance that will create data on demand.
byte[]	toByteArray() Convert this instance to a byte array.
static Bytes	viaDataOutput(IoConsumer<ExtendedDataOutput> creator) Create an instance by running the given function and storing the result in memory.
static Bytes	viaDataOutput(IoConsumer<ExtendedDataOutput> creator, int expectedSize) Create an instance by running the given function and storing the result in memory.

Method Detail

asInputStream

InputStream asInputStream()
                   throws IOException

Open an InputStream for this instance.

Returns:

Throws:

IOException

toByteArray

byte[] toByteArray()
            throws IOException

Convert this instance to a byte array.

Returns:

Throws:

IOException

asChunks

default void asChunks(ByteArrayConsumer consumer)
               throws IOException

Stream this instance to the given consumer.

Parameters:

consumer -

Throws:

IOException

asChunks

default void asChunks(int size,
                      ByteArrayConsumer consumer)
               throws IOException

Stream this instance to the given consumer with a specific chunk size.

Parameters:

size -

consumer -

Throws:

IOException

asDataInput

default ExtendedDataInput asDataInput()
                               throws IOException

Open this instance as a ExtendedDataInput.

Returns:

Throws:

IOException

empty

static Bytes empty()

Get an instance that represents no data.

Returns:

create

static Bytes create(byte[] byteArray)

Create an instance for the given array of bytes.

Parameters:

byteArray -

Returns:

create

static Bytes create(IoSupplier<InputStream> stream)

Create an instance over the given input stream.

Parameters:

stream -

Returns:

lazyViaDataOutput

static Bytes lazyViaDataOutput(IoConsumer<ExtendedDataOutput> creator)

Create an instance that will create data on demand. This will only call the creator when the contents of the returned instance is accessed.

Parameters:

creator -

Returns:

lazyViaDataOutput

static Bytes lazyViaDataOutput(IoConsumer<ExtendedDataOutput> creator,
                               int expectedSize)

Create an instance that will create data on demand. This will only call the creator when the contents of the returned instance is accessed.

Parameters:

creator -

expectedSize -

Returns:

viaDataOutput

static Bytes viaDataOutput(IoConsumer<ExtendedDataOutput> creator)
                    throws IOException

Create an instance by running the given function and storing the result in memory.

Parameters:

creator -

Returns:

Throws:

IOException

viaDataOutput

static Bytes viaDataOutput(IoConsumer<ExtendedDataOutput> creator,
                           int expectedSize)
                    throws IOException

Create an instance by running the given function and storing the result in memory.

Parameters:

creator -

expectedSize -

Returns:

Throws:

IOException

create

static BytesBuilder create()