/*
 * Copyright © 2017 Cask Data, Inc.
 *
 * Licensed 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 io.cdap.cdap.logging.meta;

import java.io.IOException;
import java.util.Map;
import java.util.Set;

/**
 * Manages reading/writing of checkpoint information for a topic and partition.
 *
 * @param <OFFSET> type of the offset
 */
public interface CheckpointManager<OFFSET> {

  /**
   * Persists the given map of {@link Checkpoint}s.
   */
  void saveCheckpoints(Map<Integer, ? extends Checkpoint<OFFSET>> checkpoints) throws IOException;

  /**
   * Reads the set of {@link Checkpoint}s for the given set of partitions.
   */
  Map<Integer, Checkpoint<OFFSET>> getCheckpoint(Set<Integer> partitions) throws IOException;

  /**
   * Reads the {@link Checkpoint} for the given partition.
   */
  Checkpoint<OFFSET> getCheckpoint(int partition) throws IOException;
}
