The readResolve Method

For Serializable and Externalizable classes, the readResolve method allows a class to replace/resolve the object read from the stream before it is returned to the caller. By implementing the readResolve method, a class can directly control the types and instances of its own instances being deserialized. The method is defined as follows:

 

ANY-ACCESS-MODIFIER Object readResolve()
throws ObjectStreamException;

 

The readResolve method is called when ObjectInputStream has read an object from the stream and is preparing to return it to the caller. ObjectInputStream checks whether the class of the object defines the readResolve method. If the method is defined, the readResolve method is called to allow the object in the stream to designate the object to be returned. The object returned should be of a type that is compatible with all uses. If it is not compatible, a ClassCastException will be thrown when the type mismatch is discovered.
For example, a Symbol class could be created for which only a single instance of each symbol binding existed within a virtual machine. The readResolve method would be implemented to determine if that symbol was already defined and substitute the preexisting equivalent Symbol object to maintain the identity constraint. In this way the uniqueness of Symbol objects can be maintained across serialization.

 

 

 // Serialzable Singleton import java.io.*; public class Elvis implements Serialzable { public static final Elvis INSTANCE = new Elvis(); private Elvis() { // ... } // ... // Remainder omitted // readResolve method to preserve singleton property private Object readResolve() throws ObjectStreamException { /* * Return the one true Elvis and let the garbage collector * take care of the Elvis impersonator. */ return INSTANCE; } public static void main(String[] args) { System.out.println(Elvis.INSTANCE); } }