org.rvpf.base.tool

Class Externalizer

Object

Externalizer

public final class Externalizer
extends Object

Externalizer.

Provides utility functions to help with values externalization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Externalizer.ValueType Value type.

Method Summary

Modifier and Type	Method and Description
static byte[]	externalize(Serializable serializable) Externalizes a serializable object to a byte array.
static byte[]	externalize(Serializable serializable, Optional<Coder> coder) Externalizes a serializable object to a byte array.
static byte	getTypeCode(byte[] byteArray) Gets the type code of a byte array.
static Serializable	internalize(byte[] byteArray) Internalizes a serializable object from a byte array.
static Serializable	internalize(byte[] byteArray, Optional<Coder> coder) Internalizes a serializable object from a byte array.
static Serializable	readSerializable(ObjectInput input) Reads a serializable from an object input.
static Optional<String>	readString(ObjectInput input) Reads a string from an object input.
static void	writeSerializable(Serializable serializable, ObjectOutput output) Writes a serializable to an object output.
static void	writeString(Optional<String> string, ObjectOutput output) Writes a string to an object output.

Methods inherited from class Object

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

Method Detail

externalize

@Nonnull
 @CheckReturnValue
public static byte[] externalize(@Nullable
                                                               Serializable serializable)

Externalizes a serializable object to a byte array.

Note: returns empty if the serializable is null.

Parameters:

serializable - The serializable object.

Returns:

The byte array.

externalize

@Nonnull
 @CheckReturnValue
public static byte[] externalize(@Nullable
                                                               Serializable serializable,
                                                               @Nonnull
                                                               Optional<Coder> coder)

Externalizes a serializable object to a byte array.

Note: returns empty if the serializable is null.

Parameters:

serializable - The serializable object.

coder - An optional coder.

Returns:

The byte array.

getTypeCode

@CheckReturnValue
public static byte getTypeCode(@Nonnull
                                                  byte[] byteArray)

Gets the type code of a byte array.

Parameters:

byteArray - The byte array.

Returns:

The type code of the byte array.

internalize

@Nullable
 @CheckReturnValue
public static Serializable internalize(@Nonnull
                                                                      byte[] byteArray)

Internalizes a serializable object from a byte array.

Note: returns null if the byte array is empty.

Parameters:

byteArray - The byte array.

Returns:

The serializable object or null.

internalize

@Nullable
 @CheckReturnValue
public static Serializable internalize(@Nonnull
                                                                      byte[] byteArray,
                                                                      @Nonnull
                                                                      Optional<Coder> coder)

Internalizes a serializable object from a byte array.

Note: returns null if the byte array is empty.

Parameters:

byteArray - The byte array.

coder - An optional coder.

Returns:

The serializable object or null.

readSerializable

@Nullable
 @CheckReturnValue
public static Serializable readSerializable(@Nonnull
                                                                           ObjectInput input)
                                                                    throws IOException

Reads a serializable from an object input.

Parameters:

input - The object input.

Returns:

The serializable or null.

Throws:

IOException - When appropriate.

readString

@Nonnull
 @CheckReturnValue
public static Optional<String> readString(@Nonnull
                                                                        ObjectInput input)
                                                                 throws IOException

Reads a string from an object input.

Parameters:

input - The object input.

Returns:

The optional string.

Throws:

IOException - When appropriate.

writeSerializable

public static void writeSerializable(@Nullable
                                     Serializable serializable,
                                     @Nonnull
                                     ObjectOutput output)
                              throws IOException

Writes a serializable to an object output.

Parameters:

serializable - The serializable or null.

output - The object output.

Throws:

IOException - When appropriate.

writeString

public static void writeString(@Nonnull
                               Optional<String> string,
                               @Nonnull
                               ObjectOutput output)
                        throws IOException

Writes a string to an object output.

Parameters:

string - The optional string.

output - The object output.

Throws:

IOException - When appropriate.