atomix-storage/src/main/java/org/opendaylight/controller/raft/journal/FromByteBufMapper.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 org.eclipse.jdt.annotation.NonNullByDefault;
  20
  21 /**
  22  * Interface for transforming bytes into their internal representation.
  23  *
  24  * @param <T> Internal representation type
  25  */
  26 @NonNullByDefault
  27 @FunctionalInterface
  28 public interface FromByteBufMapper<T> {
  29     /**
  30      * Converts the contents of a {@link ByteBuf} to an object.
  31      *
  32      * @param index entry index
  33      * @param bytes entry bytes
  34      * @return resulting object
  35      */
  36     T bytesToObject(long index, ByteBuf bytes);
  37 }