atomix-storage/src/main/java/org/opendaylight/controller/raft/journal/ToByteBufMapper.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.opendaylight.controller.raft.journal;
  17
  18 import io.netty.buffer.ByteBuf;
  19 import java.io.EOFException;
  20 import java.io.IOException;
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22
  23 /**
  24  * Interface for transforming internal represetation to bytes.
  25  *
  26  * @param <T> Internal representation type
  27  */
  28 @NonNullByDefault
  29 @FunctionalInterface
  30 public interface ToByteBufMapper<T> {
  31     /**
  32      * Converts an object into a series of bytes in the specified {@link ByteBuf}.
  33      *
  34      * @param obj the object
  35      * @param buf target buffer
  36      * @throws EOFException if the buffer does not have sufficient capacity
  37      * @throws IOException if some other I/O error occurs
  38      */
  39     void objectToBytes(T obj, ByteBuf buf) throws IOException;
  40 }