atomix-storage/src/main/java/io/atomix/storage/journal/Journal.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 io.atomix.storage.journal.JournalReader.Mode;
  19
  20 /**
  21  * Journal.
  22  *
  23  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  24  */
  25 public interface Journal<E> extends AutoCloseable {
  26     /**
  27      * Return the index of the last entry in the journal.
  28      *
  29      * @return the last index, or zero if there are no entries.
  30      */
  31     long lastIndex();
  32
  33     /**
  34      * Returns the journal writer.
  35      *
  36      * @return The journal writer.
  37      */
  38     JournalWriter<E> writer();
  39
  40     /**
  41      * Opens a new journal reader with {@link Mode#ALL}.
  42      *
  43      * @param index The index at which to start the reader.
  44      * @return A new journal reader.
  45      */
  46     default JournalReader<E> openReader(final long index) {
  47         return openReader(index, Mode.ALL);
  48     }
  49
  50     /**
  51      * Opens a new journal reader with specified mode.
  52      *
  53      * @param index The index at which to start the reader.
  54      * @param mode the reader mode
  55      * @return A new journal reader.
  56      */
  57     JournalReader<E> openReader(long index, Mode mode);
  58
  59     /**
  60      * Compacts the journal up to the given index.
  61      *
  62      * <p>
  63      * The semantics of compaction are not specified by this interface.
  64      *
  65      * @param index The index up to which to compact the journal.
  66      */
  67     void compact(long index);
  68
  69     @Override
  70     void close();
  71 }