com.github.dm.jrt.android.core

Class ParcelableByteChannel

java.lang.Object

com.github.dm.jrt.android.core.ParcelableByteChannel

public class ParcelableByteChannel
extends Object

Utility class focused on the optimization of the transfer of byte chunks through routine channels.
The generated buffers implement the parcelable interface.
Note that the streams used to write into and read from buffers should be properly closed as the Java best practices suggest.

Created by davide-maestroni on 09/03/2015.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParcelableByteChannel.ParcelableByteBuffer Parcelable buffer of bytes.

Method Summary

Methods

Modifier and Type	Method and Description
static ParcelableByteChannel	byteChannel() Returns a new byte channel.
static ParcelableByteChannel	byteChannel(int dataBufferSize) Returns a new byte channel. Since the byte buffers generated by the channel are likely to be part of a remote procedure call, be aware of the limits imposed by the Android OS architecture when choosing a specific buffer size (see TransactionTooLargeException).
static ParcelableByteChannel	byteChannel(int dataBufferSize, int corePoolSize) Returns a new byte channel. Since the byte buffers generated by the channel are likely to be part of a remote procedure call, be aware of the limits imposed by the Android OS architecture when choosing a specific buffer size (see TransactionTooLargeException).
static ByteChannel.BufferInputStream	inputStream(List<ParcelableByteChannel.ParcelableByteBuffer> buffers) Creates an input stream returning the concatenation of the data contained in the specified buffers. Note that only one input stream can be created for each buffer.
static ByteChannel.BufferInputStream	inputStream(ParcelableByteChannel.ParcelableByteBuffer... buffers) Creates an input stream returning the concatenation of the data contained in the specified buffers. Note that only one input stream can be created for each buffer.
static ByteChannel.BufferInputStream	inputStream(ParcelableByteChannel.ParcelableByteBuffer buffer) Creates an input stream returning the data contained in the specified buffer. Note that only one input stream can be created for each buffer.
ByteChannel.BufferOutputStream	passTo(InputChannel<? super ParcelableByteChannel.ParcelableByteBuffer> channel) Returns the output stream used to write bytes into the specified channel. Note that, if the method is called more than one time, passing the same input channel, it will return the same output stream.

Methods inherited from class java.lang.Object

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

Method Detail

byteChannel

@Nonnull
public static ParcelableByteChannel byteChannel()

Returns a new byte channel.

Returns:

the byte channel.

byteChannel

@Nonnull
public static ParcelableByteChannel byteChannel(int dataBufferSize)

Returns a new byte channel.
Since the byte buffers generated by the channel are likely to be part of a remote procedure call, be aware of the limits imposed by the Android OS architecture when choosing a specific buffer size (see TransactionTooLargeException).

Parameters:

dataBufferSize - the size of the data buffer used to transfer the bytes through the routine channels.

Returns:

the byte channel.

Throws:

IllegalArgumentException - if the specified size is 0 or negative.

byteChannel

@Nonnull
public static ParcelableByteChannel byteChannel(int dataBufferSize,
                                        int corePoolSize)

Returns a new byte channel.
Since the byte buffers generated by the channel are likely to be part of a remote procedure call, be aware of the limits imposed by the Android OS architecture when choosing a specific buffer size (see TransactionTooLargeException).

Parameters:

dataBufferSize - the size of the data buffer used to transfer the bytes through the routine channels.

corePoolSize - the maximum number of data retained in the pool. Additional data created to fulfill the bytes requirement will be discarded.

Returns:

the byte channel.

Throws:

IllegalArgumentException - if the specified size is 0 or negative.

inputStream

@Nonnull
public static ByteChannel.BufferInputStream inputStream(@Nonnull
                                                ParcelableByteChannel.ParcelableByteBuffer buffer)

Creates an input stream returning the data contained in the specified buffer.
Note that only one input stream can be created for each buffer.

Parameters:

buffer - the byte buffer.

Returns:

the input stream.

Throws:

IllegalStateException - if an input stream has been already created for the specified buffer.

inputStream

@Nonnull
public static ByteChannel.BufferInputStream inputStream(@Nonnull
                                                ParcelableByteChannel.ParcelableByteBuffer... buffers)

Creates an input stream returning the concatenation of the data contained in the specified buffers.
Note that only one input stream can be created for each buffer.

Parameters:

buffers - the byte buffers whose data have to be concatenated.

Returns:

the input stream.

Throws:

IllegalStateException - if an input stream has been already created for one of the specified buffers.

inputStream

@Nonnull
public static ByteChannel.BufferInputStream inputStream(@Nonnull
                                                List<ParcelableByteChannel.ParcelableByteBuffer> buffers)

Creates an input stream returning the concatenation of the data contained in the specified buffers.
Note that only one input stream can be created for each buffer.

Parameters:

buffers - the byte buffers whose data have to be concatenated.

Returns:

the input stream.

Throws:

IllegalStateException - if an input stream has been already created for one of the specified buffers.

passTo

@Nonnull
public ByteChannel.BufferOutputStream passTo(@Nonnull
                                            InputChannel<? super ParcelableByteChannel.ParcelableByteBuffer> channel)

Returns the output stream used to write bytes into the specified channel.
Note that, if the method is called more than one time, passing the same input channel, it will return the same output stream.

Parameters:

channel - the input channel to which to pass the data.

Returns:

the output stream.