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  *
   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 com.google.common.base.MoreObjects;
  19
  20 /**
  21  * Indexed journal entry.
  22  *
  23  * @param <E> entry type
  24  * @param index the entry index
  25  * @param entry the indexed entry
  26  * @param size the serialized entry size
  27  */
  28 // FIXME: add @NonNullByDefault and enforce non-null entry once we can say that entries cannot be null
  29 // FIXME: it seems 'index' has to be non-zero, we should enforce that if that really is the case
  30 // FIXME: it seems 'size' has not be non-zero, we should enforce that if that really is the case
  31 public record Indexed<E>(long index, E entry, int size) {
  32     @Override
  33     public String toString() {
  34         return MoreObjects.toStringHelper(this).add("index", index).add("entry", entry).toString();
  35     }
  36 }