com.hazelcast.spi.serialization.SerializationService Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2017, Hazelcast, Inc. All Rights Reserved.
*
* 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 com.hazelcast.spi.serialization;
import com.hazelcast.core.ManagedContext;
import com.hazelcast.core.PartitioningStrategy;
import com.hazelcast.nio.serialization.Data;
/**
* SPI to serialize user objects to {@link Data} and back to Object
* {@link Data} is the internal representation of binary data in hazelcast.
*/
public interface SerializationService {
/**
* Serializes an object to a {@link Data}.
*
* This method can safely be called with a {@link Data} instance. In that case, that instance is returned.
*
* If this method is called with null, null is returned.
*
* @param obj the object to serialize.
* @return the serialized object.
* @throws com.hazelcast.nio.serialization.HazelcastSerializationException when serialization fails.
*/
B toData(Object obj);
/**
* Serializes an object to a {@link Data}.
*
* This method can safely be called with a {@link Data} instance. In that case, that instance is returned.
*
* If this method is called with null, null is returned.
*
* @param obj the object to serialize.
* @param strategy strategy is used to calculate partition id of the resulting data see {@link PartitioningStrategy}
* @return the serialized object.
* @throws com.hazelcast.nio.serialization.HazelcastSerializationException when serialization fails.
*/
B toData(Object obj, PartitioningStrategy strategy);
/**
* Deserializes an object.
*
* This method can safely be called on an object that is already deserialized. In that case, that instance
* is returned.
*
* If this method is called with null, null is returned.
*
* @param data the data to deserialize.
* @return the deserialized object.
* @throws com.hazelcast.nio.serialization.HazelcastSerializationException when deserialization fails.
*/
T toObject(Object data);
/**
* Deserializes an object.
*
* This method can safely be called on an object that is already deserialized. In that case, that instance
* is returned.
*
* If this method is called with null, null is returned.
*
* @param data the data to deserialize.
* @param klazz The class to instantiate when deserializing the object.
* @return the deserialized object.
* @throws com.hazelcast.nio.serialization.HazelcastSerializationException when deserialization fails.
*/
T toObject(Object data, Class klazz);
/**
* see {@link com.hazelcast.config.Config#setManagedContext(ManagedContext)}
*
* @return ManagedContext that is set by user in Config
*/
ManagedContext getManagedContext();
}