/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.cassandra.dht;

import java.io.DataInput;
import java.io.IOException;

import org.apache.cassandra.io.util.DataOutputPlus;

Versioned serializer where the serialization depends on partitioner.
On serialization the partitioner is given by the entity being serialized. To deserialize the partitioner used must
be known to the calling method.
/**
 * Versioned serializer where the serialization depends on partitioner.
 *
 * On serialization the partitioner is given by the entity being serialized. To deserialize the partitioner used must
 * be known to the calling method.
 */
public interface IPartitionerDependentSerializer<T>
{
    
Serialize the specified type into the specified DataOutputStream instance.
Params:
t – type that needs to be serialized
out – DataOutput into which serialization needs to happen.
version – protocol version
Throws:
IOException – if serialization fails/**
     * Serialize the specified type into the specified DataOutputStream instance.
     *
     * @param t type that needs to be serialized
     * @param out DataOutput into which serialization needs to happen.
     * @param version protocol version
     * @throws java.io.IOException if serialization fails
     */
    public void serialize(T t, DataOutputPlus out, int version) throws IOException;

    
Deserialize into the specified DataInputStream instance.
Params:
in – DataInput from which deserialization needs to happen.
p – Partitioner that will be used to construct tokens. Needs to match the partitioner that was used to
    serialize the token.
version – protocol version
Throws:
IOException – if deserialization fails
Returns:
the type that was deserialized/**
     * Deserialize into the specified DataInputStream instance.
     * @param in DataInput from which deserialization needs to happen.
     * @param p Partitioner that will be used to construct tokens. Needs to match the partitioner that was used to
     *     serialize the token.
     * @param version protocol version
     * @return the type that was deserialized
     * @throws IOException if deserialization fails
     */
    public T deserialize(DataInput in, IPartitioner p, int version) throws IOException;

    
Calculate serialized size of object without actually serializing.
Params:
t – object to calculate serialized size
version – protocol version
Returns:
serialized size of object t/**
     * Calculate serialized size of object without actually serializing.
     * @param t object to calculate serialized size
     * @param version protocol version
     * @return serialized size of object t
     */
    public long serializedSize(T t, int version);
}