/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.codecs.lucene90.compressing;

import java.io.Closeable;
import java.io.IOException;

abstract class FieldsIndex implements Cloneable, Closeable {

  /** Get the ID of the block that contains the given docID. */
  abstract long getBlockID(int docID);

  /** Get the start pointer of the block with the given ID. */
  abstract long getBlockStartPointer(long blockID);

  /** Get the number of bytes of the block with the given ID. */
  abstract long getBlockLength(long blockID);

  /** Get the start pointer of the block that contains the given docID. */
  final long getStartPointer(int docID) {
    return getBlockStartPointer(getBlockID(docID));
  }

  /** Check the integrity of the index. */
  abstract void checkIntegrity() throws IOException;

  @Override
  public abstract FieldsIndex clone();
}
