co.paralleluniverse.common.io

Class Streamables

java.lang.Object

co.paralleluniverse.common.io.Streamables

public final class Streamables
extends Object

Provides utility methods for working with Streamables and/or data streams.

Constructor Summary

Constructors

Constructor and Description
Streamables()

Method Summary

Methods

Modifier and Type	Method and Description
static int	calcUtfLength(String str) Returns the length in bytes of a string's UTF-8 encoding.
Object	fromByteArray(byte[] array)
static void	fromByteArray(Streamable streamable, byte[] array) Reads a Streamable's serialized contents from a byte array.
static void	fromByteArray(Streamable streamable, byte[] array, int offset) Reads a Streamable's serialized contents from a byte array.
static void	fromByteArray(Streamable streamable, byte[] array, int offset, int length) Reads a Streamable's serialized contents from a byte array.
Object	read(DataInput in)
<T extends Streamable> void	register(byte qualifier, Class<T> clazz)
static byte[]	toByteArray(Streamable streamable) Serializes a Streamable into a byte array.
static void	writeBuffer(DataOutput out, ByteBuffer buffer) Writes the given ByteBuffer into the given DataOutput.

Methods inherited from class java.lang.Object

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

Constructor Detail

Streamables

public Streamables()

Method Detail

toByteArray

public static byte[] toByteArray(Streamable streamable)

Serializes a Streamable into a byte array.

Parameters:

streamable - The object to serialize.

Returns:

A byte array containing the serialized object.

fromByteArray

public static void fromByteArray(Streamable streamable,
                 byte[] array)

Reads a Streamable's serialized contents from a byte array. The serialized form begins in the beginning of the array and extends to the end of the array.

Same as calling fromByteArray(streamable, array, 0, array.length).

Parameters:

streamable - The object whose contents are to be read.

array - The array from which to read the serialized form.

fromByteArray

public static void fromByteArray(Streamable streamable,
                 byte[] array,
                 int offset)

Reads a Streamable's serialized contents from a byte array. The serialized form begins in the given offset and extends to the end of the array.

Same as calling fromByteArray(streamable, array, offset, array.length - offset).

Parameters:

streamable - The object whose contents are to be read.

array - The array from which to read the serialized form.

offset - The offset into the array from which to start reading the serialized form.

fromByteArray

public static void fromByteArray(Streamable streamable,
                 byte[] array,
                 int offset,
                 int length)

Reads a Streamable's serialized contents from a byte array.

Parameters:

streamable - The object whose contents are to be read.

array - The array from which to read the serialized form.

offset - The offset into the array from which to start reading the serialized form.

length - The length of the serialized form to read from the array.

writeBuffer

public static void writeBuffer(DataOutput out,
               ByteBuffer buffer)
                        throws IOException

Writes the given ByteBuffer into the given DataOutput.

Parameters:

out - The DataOutput into which the buffer will be written.

buffer - The buffer to write into the DataOutput.

Throws:

IOException

calcUtfLength

public static int calcUtfLength(String str)

Returns the length in bytes of a string's UTF-8 encoding.

Parameters:

str - The string to measure.

Returns:

The length in bytes of a string's UTF-8 encoding.

register

public <T extends Streamable> void register(byte qualifier,
                                   Class<T> clazz)

read

public Object read(DataInput in)
            throws IOException

Throws:

IOException

fromByteArray

public Object fromByteArray(byte[] array)
                     throws IOException

Throws:

IOException