com.aitusoftware.recall.persistence.Encoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of recall-store Show documentation

Recall: An off-heap garbage-free object store

There is a newer version: 1.1.0

/*
 * Copyright 2019 Aitu Software Limited.
 *
 * https://aitusoftware.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 com.aitusoftware.recall.persistence;

/**
 * Serialiser to be used with a {@code Store}.
 *
 * @param  type of the buffer
 * @param  type of the instance
 */
@FunctionalInterface
public interface Encoder
{
    /**
     * Encodes the specified value into the supplied buffer.
     *
     * @param buffer target buffer
     * @param offset offset into the buffer
     * @param value  value to encode
     */
    void store(B buffer, int offset, T value);
}