/*
 * 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.cassandra.index.sai.utils;

import java.io.Closeable;
import java.nio.ByteBuffer;
import java.util.Iterator;

import javax.annotation.concurrent.NotThreadSafe;

/**
 * An iterator over the contents of an index that extends {@link Iterator}&lt;{@link IndexEntry}&gt; that provides the min and max
 * terms in the index. Each {@link IndexEntry} contains a term and the postings associated with that term.
 */
@NotThreadSafe
public interface TermsIterator extends Iterator<IndexEntry>, Closeable
{
    ByteBuffer getMinTerm();

    ByteBuffer getMaxTerm();
}
