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.IOException;
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21
  22 /**
  23  * Support for mapping of {@link ByteBufJournal} entries to and from {@link ByteBuf}s.
  24  */
  25 @NonNullByDefault
  26 public interface ByteBufMapper<T> {
  27     /**
  28      * Converts the contents of a {@link ByteBuf} to an object.
  29      *
  30      * @param index entry index
  31      * @param bytes entry bytes
  32      * @return resulting object
  33      */
  34     T bytesToObject(final long index, ByteBuf bytes);
  35
  36     /**
  37      * Converts an object into a series of bytes in the specified {@link ByteBuf}.
  38      *
  39      * @param obj the object
  40      * @param buf target buffer
  41      * @throws IOException if an I/O error occurs
  42      */
  43     void objectToBytes(T obj, ByteBuf buf) throws IOException;
  44 }