atomix-storage/src/main/java/io/atomix/storage/journal/ByteBufMapper.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 io.atomix.storage.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  * Support for mapping of {@link ByteBufJournal} entries to and from {@link ByteBuf}s.
  25  */
  26 @NonNullByDefault
  27 public interface ByteBufMapper<T> {
  28     /**
  29      * Converts the contents of a {@link ByteBuf} to an object.
  30      *
  31      * @param index entry index
  32      * @param bytes entry bytes
  33      * @return resulting object
  34      */
  35     T bytesToObject(long index, ByteBuf bytes);
  36
  37     /**
  38      * Converts an object into a series of bytes in the specified {@link ByteBuf}.
  39      *
  40      * @param obj the object
  41      * @param buf target buffer
  42      * @throws EOFException if the buffer does not have sufficient capacity
  43      * @throws IOException if some other I/O error occurs
  44      */
  45     void objectToBytes(T obj, ByteBuf buf) throws IOException;
  46 }