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 org.eclipse.jdt.annotation.NonNullByDefault;
  20
  21 /**
  22  * Support for serialization of {@link ByteBufJournal} entries.
  23  */
  24 @NonNullByDefault
  25 public interface ByteBufMapper<T> {
  26     /**
  27      * Converts an object into a series of bytes in a {@link ByteBuf}.
  28      *
  29      * @param obj the object
  30      * @return resulting buffer
  31      */
  32     ByteBuf objectToBytes(T obj) ;
  33
  34     /**
  35      * Converts the contents of a {@link ByteBuf} to an object.
  36      *
  37      * @param buf buffer to convert
  38      * @return resulting object
  39      */
  40     T bytesToObject(ByteBuf buf);
  41 }