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