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

   1 /*
   2  * Copyright 2018-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.index;
  17
  18 /**
  19  * Journal index.
  20  */
  21 public interface JournalIndex {
  22
  23   /**
  24    * Adds an entry for the given index at the given position.
  25    *
  26    * @param index the index for which to add the entry
  27    * @param position the position of the given index
  28    */
  29   void index(long index, int position);
  30
  31   /**
  32    * Looks up the position of the given index.
  33    *
  34    * @param index the index to lookup
  35    * @return the position of the given index or a lesser index
  36    */
  37   Position lookup(long index);
  38
  39   /**
  40    * Truncates the index to the given index.
  41    *
  42    * @param index the index to which to truncate the index
  43    */
  44   void truncate(long index);
  45
  46 }