atomix-storage/src/main/java/io/atomix/storage/journal/Indexed.java

   1 /*
   2  * Copyright 2017-2022 Open Networking Foundation and others.  All rights reserved.
   3  * Copyright (c) 2024 PANTHEON.tech, s.r.o.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  * http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 package io.atomix.storage.journal;
  18
  19 import static java.util.Objects.requireNonNull;
  20
  21 import com.google.common.base.MoreObjects;
  22 import io.atomix.storage.journal.index.Position;
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24
  25 /**
  26  * Indexed journal entry.
  27  *
  28  * @param <E> entry type
  29  * @param index the entry index
  30  * @param entry the indexed entry
  31  * @param size the serialized entry size
  32  */
  33 // FIXME: it seems 'index' has to be non-zero, we should enforce that if that really is the case
  34 // FIXME: it seems 'size' has not be non-zero, we should enforce that if that really is the case
  35 @NonNullByDefault
  36 public record Indexed<E>(long index, E entry, int size) {
  37     public Indexed {
  38         requireNonNull(entry);
  39     }
  40
  41     Indexed(final Position position, final E entry, final int size) {
  42         this(position.index(), entry, size);
  43     }
  44
  45     @Override
  46     public String toString() {
  47         return MoreObjects.toStringHelper(this).add("index", index).add("entry", entry).toString();
  48     }
  49 }