io.fluxcapacitor.javaclient.common.serialization.Serializer Maven / Gradle / Ivy
Show all versions of java-client Show documentation
/*
* Copyright (c) 2016-2017 Flux Capacitor.
*
* 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 io.fluxcapacitor.javaclient.common.serialization;
import io.fluxcapacitor.common.api.Data;
import io.fluxcapacitor.common.api.SerializedObject;
import java.util.List;
import java.util.stream.Stream;
import static java.util.stream.Collectors.toList;
/**
* Mechanism to convert objects to a byte array and vice versa.
*/
public interface Serializer {
/**
* Serializes an object to a {@link Data} object containing a byte array.
*
* @param object The instance to serialize
* @return Data object containing byte array representation of the object
* @throws SerializationException if serialization fails
*/
Data serialize(Object object);
/**
* Upcasts and deserializes the given {@link Data} object to an object of type T. If the input data cannot
* be deserialized to a single result (due to upcasting) a {@link SerializationException} is thrown.
*
* @param data Data to deserialize
* @param Type of object to deserialize to
* @return Object resulting from the deserialization
* @throws SerializationException if deserialization fails
*/
@SuppressWarnings("unchecked")
default T deserialize(Data data) {
List list = deserialize(Stream.of(data), true).map(d -> (T) d.getPayload()).collect(toList());
if (list.size() != 1) {
throw new SerializationException(
String.format("Invalid deserialization result for a '%s'. Expected a single object but got %s",
data, list));
}
return list.get(0);
}
/**
* Upcasts and deserializes a stream of serialized objects. Each result in the output stream contains both a
* provider for the deserialized object and the serialized object after upcasting that is used as the source of the
* deserialized object.
*
* Deserialization is performed lazily. This means that actual conversion for a given result in the output stream
* only happens if {@link DeserializingObject#getPayload()} is invoked on the result. This has the advantage that a
* caller can inspect what type will be returned via {@link DeserializingObject#getSerializedObject()} before
* deciding to go through with the deserialization.
*
* You can specify whether deserialization of a result in the output stream should fail with a {@link
* SerializationException} if a type is unknown (not a class). It is up to the implementation to determine what
* should happen if a type is unknown but the {@code failOnUnknownType} flag is false.
*
* @param dataStream data input stream to deserialize
* @param failOnUnknownType flag that determines whether deserialization of an unknown type should give an
* exception
* @param the type of the serialized object
* @return a stream containing deserialization results
*/
> Stream> deserialize(Stream dataStream,
boolean failOnUnknownType);
}