001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.regionserver;
019
020import java.io.IOException;
021import java.util.Iterator;
022import org.apache.hadoop.hbase.ExtendedCell;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * The MemStoreSegmentsIterator is designed to perform one iteration over given list of segments For
027 * another iteration new instance of MemStoreSegmentsIterator needs to be created The iterator is
028 * not thread-safe and must have only one instance per MemStore in each period of time
029 */
030@InterfaceAudience.Private
031public abstract class MemStoreSegmentsIterator implements Iterator<ExtendedCell> {
032
033  protected final ScannerContext scannerContext;
034
035  // C-tor
036  public MemStoreSegmentsIterator(int compactionKVMax) throws IOException {
037    this.scannerContext = ScannerContext.newBuilder().setBatchLimit(compactionKVMax).build();
038  }
039
040  public abstract void close();
041}