io.hekate.codec.EncodeFunction Maven / Gradle / Ivy

Go to download

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

Java library for cluster communications and computing.

There is a newer version: 4.1.3

/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project 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 io.hekate.codec;

import java.io.IOException;

/**
 * Functional interface for data encoding into a binary format.
 *
 * @param  Type of the input to the function.
 */
@FunctionalInterface
public interface EncodeFunction {
    /**
     * Encodes object into the provided writer.
     *
     * @param obj Object to encode.
     * @param out Data writer.
     *
     * @throws IOException If object couldn't be encoded.
     */
    void encode(T obj, DataWriter out) throws IOException;
}