2 * Copyright 2017-2022 Open Networking Foundation and others. All rights reserved.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package io.atomix.storage.journal;
18 import java.io.Closeable;
23 * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
25 public interface Journal<E> extends Closeable {
28 * Returns the journal writer.
30 * @return The journal writer.
32 JournalWriter<E> writer();
35 * Opens a new journal reader.
37 * @param index The index at which to start the reader.
38 * @return A new journal reader.
40 JournalReader<E> openReader(long index);
43 * Opens a new journal reader.
45 * @param index The index at which to start the reader.
46 * @param mode the reader mode
47 * @return A new journal reader.
49 JournalReader<E> openReader(long index, JournalReader.Mode mode);
52 * Returns a boolean indicating whether the journal is open.
54 * @return Indicates whether the journal is open.