org.caffinitas.ohc.CacheSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ohc-core Show documentation

Off-Heap concurrent hash map intended to store GBs of serialized data

There is a newer version: 0.7.4

/*
 *      Copyright (C) 2014 Robert Stupp, Koeln, Germany, robert-stupp.de
 *
 *   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 org.caffinitas.ohc;

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

/**
 * Serialize and deserialize cached data using {@link java.io.DataInput} and {@link java.io.DataOutput}.
 */
public interface CacheSerializer
{
    /**
     * Serialize the specified type into the specified {@code DataOutput} instance.
     *
     * @param t   type that needs to be serialized
     * @param out {@code DataOutput} into which serialization needs to happen.
     */
    public void serialize(T t, DataOutput out) throws IOException;

    /**
     * Deserialize from the specified {@code DataInput} instance.
     *
     * @param in {@code DataInput} from which deserialization needs to happen.
     * @return the type that was deserialized
     */
    public T deserialize(DataInput in) throws IOException;

    /**
     * Calculate the number of bytes that will be produced by {@link #serialize(Object, java.io.DataOutput)}
     * for given object {@code t}.
     *
     * @param t object to calculate serialized size for
     * @return serialized size of {@code t}
     */
    public int serializedSize(T t);
}