third-party/atomix/storage/src/main/java/io/atomix/storage/journal/Journal.java

   1 /*
   2  * Copyright 2017-present Open Networking Foundation
   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 java.io.Closeable;
  19
  20 /**
  21  * Journal.
  22  *
  23  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  24  */
  25 public interface Journal<E> extends Closeable {
  26
  27   /**
  28    * Returns the journal writer.
  29    *
  30    * @return The journal writer.
  31    */
  32   JournalWriter<E> writer();
  33
  34   /**
  35    * Opens a new journal reader.
  36    *
  37    * @param index The index at which to start the reader.
  38    * @return A new journal reader.
  39    */
  40   JournalReader<E> openReader(long index);
  41
  42   /**
  43    * Opens a new journal reader.
  44    *
  45    * @param index The index at which to start the reader.
  46    * @param mode the reader mode
  47    * @return A new journal reader.
  48    */
  49   JournalReader<E> openReader(long index, JournalReader.Mode mode);
  50
  51   /**
  52    * Returns a boolean indicating whether the journal is open.
  53    *
  54    * @return Indicates whether the journal is open.
  55    */
  56   boolean isOpen();
  57
  58   @Override
  59   void close();
  60 }