/*
* Copyright 2016 higherfrequencytrading.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.openhft.lang.io.serialization;
import net.openhft.lang.io.Bytes;
import net.openhft.lang.model.constraints.NotNull;
import java.io.*;
/**
* Abstracts serialization implementation, which at least should be able to serialize objects that
* Java built-in serialization is able serialize. In other words, {@code ObjectSerializer} abstracts
* Java serialization re-implementations and extensions. {@link Bytes} is used as core IO interface
* instead of {@link InputStream} + {@link OutputStream} pair, which Java built-in serialization
* use. However, note that {@code Bytes} could always be converted to these old interfaces by
* {@link Bytes#inputStream()} and {@link Bytes#outputStream()}, if needed.
*
* <p>The default fallback implementation is Java built-in serialization itself:
* {@link JDKObjectSerializer}.
*
* <p>Another provided implementation is {@link BytesMarshallableSerializer}, which basically
* extends built-in serialization with some improvements. For example, it could benefit if objects
* implement {@link BytesMarshallable} interface the same way as built-in serialization benefit
* if objects implement {@link Externalizable}. See {@link BytesMarshallableSerializer} docs for
* more information.
*
* <p>This interface is supposed to be implemented to plug such third-party serialization
* re-implementations, as Kryo, fast-serialization, etc.
*/
public interface ObjectSerializer extends Serializable {
/**
* write an object
*
* @param bytes to write to
* @param object object to write
* @param expectedClass which will be provided on read, can be null
*/
void writeSerializable(@NotNull Bytes bytes, Object object, Class expectedClass) throws IOException;
/**
* Read an object
*
* @param bytes to read
* @param expectedClass proved when writing, can be null
* @param object to populate, can be null
* @return object read.
* @throws IOException if it not possible to serialize the object
* @throws ClassNotFoundException if the expectedClass can not be created
*/
<T> T readSerializable(@NotNull Bytes bytes, Class<T> expectedClass, T object) throws IOException, ClassNotFoundException;
}