Module io.jenetics.base

Package io.jenetics.internal.util

Class SerialIO

java.lang.Object

io.jenetics.internal.util.SerialIO

public final class SerialIO
extends Object

Helper methods needed for implementing the Java serializations.

Since:

5.0

Version:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SerialIO.Reader<T>	Object reader interface
static interface	SerialIO.Writer<T>	Object writer interface.

Method Summary

Modifier and Type	Method	Description
static byte[]	readBytes(DataInput in)
static char[]	readCharArray(DataInput in)	Read an char[] array from the data input.
static double[]	readDoubleArray(DataInput in)	Read a double[] array from the data input.
static int	readInt(DataInput in)	Reads an int value from the given data input.
static int[]	readIntArray(DataInput in)	Read an int[] array from the data input.
static long	readLong(DataInput in)	Reads a long value from the given data input.
static long[]	readLongArray(DataInput in)	Read a long[] array from the data input.
static <T> T	readNullable(SerialIO.Reader<? extends T> reader, DataInput in)	Reads a possible null value from the given data input.
static String	readNullableString(DataInput in)	Reads a, possible null, string value from the given data input.
static Object[]	readObjectArray(ObjectInput in)	Read an Object[] array from the data input.
static <T> List<T>	reads(SerialIO.Reader<? extends T> reader, DataInput in)	Reads a list of elements from the given data input.
static String	readString(DataInput in)	Reads a string value from the given data input.
static void	writeBytes(byte[] bytes, DataOutput out)
static void	writeCharArray(char[] values, DataOutput out)	Write the given char[] array to the given data output.
static void	writeDoubleArray(double[] values, DataOutput out)	Write the given double[] array to the given data output.
static void	writeInt(int value, DataOutput out)	Writes an int value to a series of bytes.
static void	writeIntArray(int[] values, DataOutput out)	Write the given int[] array to the given data output.
static void	writeLong(long value, DataOutput out)	Writes a long value to a series of bytes.
static void	writeLongArray(long[] values, DataOutput out)	Write the given long[] array to the given data output.
static <T> void	writeNullable(T value, SerialIO.Writer<? super T> writer, DataOutput out)	Write the given, possible null, value to the data output using the given writer.
static void	writeNullableString(String value, DataOutput out)	Write the given string, possible null, value to the given data output.
static void	writeObjectArray(Object[] values, ObjectOutput out)	Write the given Object[] array to the given data output.
static <T> void	writes(Collection<? extends T> elements, SerialIO.Writer<? super T> writer, DataOutput out)	Write the given elements to the data output.
static void	writeString(String value, DataOutput out)	Write the given string value to the given data output.

Methods inherited from class java.lang.Object

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

Method Details

writeNullable

public static <T> void writeNullable(T value,
 SerialIO.Writer<? super T> writer,
 DataOutput out)
                              throws IOException

Write the given, possible null, value to the data output using the given writer.

Type Parameters:

T - the object type

Parameters:

value - the, possible null, value to write

writer - the object writer

out - the data output

Throws:

NullPointerException - if the writer or data output is null

IOException - if an I/O error occurs

readNullable

public static <T> T readNullable(SerialIO.Reader<? extends T> reader,
 DataInput in)
                          throws IOException

Reads a possible null value from the given data input.

Type Parameters:

T - the object type

Parameters:

reader - the object reader

in - the data input

Returns:

the read object

Throws:

NullPointerException - if one of the given arguments is null

IOException - if an I/O error occurs

writeString

public static void writeString(String value,
 DataOutput out)
                        throws IOException

Write the given string value to the given data output.

Parameters:

value - the string value to write

out - the data output

Throws:

NullPointerException - if one of the given arguments is null

IOException - if an I/O error occurs

readString

public static String readString(DataInput in)
                         throws IOException

Reads a string value from the given data input.

Parameters:

in - the data input

Returns:

the read string value

Throws:

NullPointerException - if one of the given arguments is null

IOException - if an I/O error occurs

writeNullableString

public static void writeNullableString(String value,
 DataOutput out)
                                throws IOException

Write the given string, possible null, value to the given data output.

Parameters:

value - the string value to write

out - the data output

Throws:

NullPointerException - if the given data output is null

IOException - if an I/O error occurs

readNullableString

public static String readNullableString(DataInput in)
                                 throws IOException

Reads a, possible null, string value from the given data input.

Parameters:

in - the data input

Returns:

the read string value

Throws:

NullPointerException - if one of the given arguments is null

IOException - if an I/O error occurs

writes

public static <T> void writes(Collection<? extends T> elements,
 SerialIO.Writer<? super T> writer,
 DataOutput out)
                       throws IOException

Write the given elements to the data output.

Type Parameters:

T - the element type

Parameters:

elements - the elements to write

writer - the element writer

out - the data output

Throws:

NullPointerException - if one of the given arguments is null

IOException - if an I/O error occurs

reads

public static <T> List<T> reads(SerialIO.Reader<? extends T> reader,
 DataInput in)
                         throws IOException

Reads a list of elements from the given data input.

Type Parameters:

T - the element type

Parameters:

reader - the element reader

in - the data input

Returns:

the read element list

Throws:

NullPointerException - if one of the given arguments is null

IOException - if an I/O error occurs

writeBytes

public static void writeBytes(byte[] bytes,
 DataOutput out)
                       throws IOException

Throws:

IOException

readBytes

public static byte[] readBytes(DataInput in)
                        throws IOException

Throws:

IOException

writeInt

public static void writeInt(int value,
 DataOutput out)
                     throws IOException

Writes an int value to a series of bytes. The values are written using variable-length zig-zag coding. Each int value is written in 1 to 5 bytes.

Parameters:

value - the integer value to write

out - the data output the integer value is written to

Throws:

NullPointerException - if the given data output is null

IOException - if an I/O error occurs

See Also:

• readInt(DataInput)

readInt

public static int readInt(DataInput in)
                   throws IOException

Reads an int value from the given data input. The integer value must have been written by the writeInt(int, DataOutput) before.

Parameters:

in - the data input where the integer value is read from

Returns:

the read integer value

Throws:

NullPointerException - if the given data input is null

IOException - if an I/O error occurs

See Also:

• writeInt(int, DataOutput)

writeLong

public static void writeLong(long value,
 DataOutput out)
                      throws IOException

Writes a long value to a series of bytes. The values are written using variable-length zig-zag coding. Each long value is written in 1 to 10 bytes.

Parameters:

value - the long value to write

out - the data output the integer value is written to

Throws:

NullPointerException - if the given data output is null

IOException - if an I/O error occurs

See Also:

• readLong(DataInput)

readLong

public static long readLong(DataInput in)
                     throws IOException

Reads a long value from the given data input. The integer value must have been written by the writeInt(int, DataOutput) before.

Parameters:

in - the data input where the integer value is read from

Returns:

the read long value

Throws:

NullPointerException - if the given data input is null

IOException - if an I/O error occurs

See Also:

• writeLong(long, DataOutput)

writeIntArray

public static void writeIntArray(int[] values,
 DataOutput out)
                          throws IOException

Write the given int[] array to the given data output.

Parameters:

values - the values to write

out - the data sink

Throws:

IOException - if an I/O error occurs

writeCharArray

public static void writeCharArray(char[] values,
 DataOutput out)
                           throws IOException

Write the given char[] array to the given data output.

Parameters:

values - the values to write

out - the data sink

Throws:

IOException - if an I/O error occurs

writeLongArray

public static void writeLongArray(long[] values,
 DataOutput out)
                           throws IOException

Write the given long[] array to the given data output.

Parameters:

values - the values to write

out - the data sink

Throws:

IOException - if an I/O error occurs

writeDoubleArray

public static void writeDoubleArray(double[] values,
 DataOutput out)
                             throws IOException

Write the given double[] array to the given data output.

Parameters:

values - the values to write

out - the data sink

Throws:

IOException - if an I/O error occurs

readCharArray

public static char[] readCharArray(DataInput in)
                            throws IOException

Read an char[] array from the data input.

Parameters:

in - the data source

Returns:

the read values

Throws:

IOException - if an I/O error occurs

readIntArray

public static int[] readIntArray(DataInput in)
                          throws IOException

Read an int[] array from the data input.

Parameters:

in - the data source

Returns:

the read values

Throws:

IOException - if an I/O error occurs

readLongArray

public static long[] readLongArray(DataInput in)
                            throws IOException

Read a long[] array from the data input.

Parameters:

in - the data source

Returns:

the read values

Throws:

IOException - if an I/O error occurs

readDoubleArray

public static double[] readDoubleArray(DataInput in)
                                throws IOException

Read a double[] array from the data input.

Parameters:

in - the data source

Returns:

the read values

Throws:

IOException - if an I/O error occurs

writeObjectArray

public static void writeObjectArray(Object[] values,
 ObjectOutput out)
                             throws IOException

Write the given Object[] array to the given data output.

Parameters:

values - the values to write

out - the data sink

Throws:

IOException - if an I/O error occurs

readObjectArray

public static Object[] readObjectArray(ObjectInput in)
                                throws IOException,
ClassNotFoundException

Read an Object[] array from the data input.

Parameters:

in - the data source

Returns:

the read values

Throws:

IOException - if an I/O error occurs

ClassNotFoundException - if the class can't be loaded