2 * Copyright 2017-present Open Networking Foundation
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;
21 * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
23 public interface JournalWriter<E> extends AutoCloseable {
26 * Returns the last written index.
28 * @return The last written index.
33 * Returns the last entry written.
35 * @return The last entry written.
37 Indexed<E> getLastEntry();
40 * Returns the next index to be written.
42 * @return The next index to be written.
47 * Appends an entry to the journal.
49 * @param entry The entry to append.
50 * @return The appended indexed entry.
52 <T extends E> Indexed<T> append(T entry);
55 * Appends an indexed entry to the log.
57 * @param entry The indexed entry to append.
59 void append(Indexed<E> entry);
62 * Commits entries up to the given index.
64 * @param index The index up to which to commit entries.
66 void commit(long index);
69 * Resets the head of the journal to the given index.
71 * @param index the index to which to reset the head of the journal
73 void reset(long index);
76 * Truncates the log to the given index.
78 * @param index The index to which to truncate the log.
80 void truncate(long index);
83 * Flushes written entries to disk.