Module imagingbook.common

Package imagingbook.common.util

Class SerializationHelper

java.lang.Object

imagingbook.common.util.SerializationHelper

public abstract class SerializationHelper
extends Object

Helper class providing static methods for writing/reading serialized data to/from files. It is recommended to serialize only data structures composed of standard Java types. Otherwise, if self-defined classes are reloaded, classes of previously serialized objects may not match any more, causing a ClassNotFoundException to be thrown.

Version:

2022/07/28

Method Summary

Modifier and Type	Method	Description
static Object	readObject(File file)	Reads an object from a serialization file.
static String	writeObject(Object obj, File file)	Writes a serialized representation of an arbitrary Java object to a file.

Methods inherited from class java.lang.Object

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

Method Details

writeObject

public static String writeObject(Object obj,
 File file)

Writes a serialized representation of an arbitrary Java object to a file.

Parameters:

obj - the object to be serialized.

file - the file to write to.

Returns:

the full path of the written file.

readObject

public static Object readObject(File file)

Reads an object from a serialization file. The return value must be cast to the appropriate type, which must be known.

Parameters:

file - the file to read.

Returns:

the object reconstructed from the file representation or null if unsuccessful.