/*
 * 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.db.columniterator;

import java.io.IOException;
import org.apache.cassandra.db.ColumnFamily;
import org.apache.cassandra.db.DecoratedKey;
import org.apache.cassandra.db.OnDiskAtom;
import org.apache.cassandra.utils.CloseableIterator;

public interface OnDiskAtomIterator extends CloseableIterator<OnDiskAtom>
{
    /**
     * @return A ColumnFamily holding metadata for the row being iterated.
     * Do not modify this CF. Whether it is empty or not is implementation-dependent.
     */
    public abstract ColumnFamily getColumnFamily();

    /**
     * @return the current row key
     */
    public DecoratedKey getKey();

    /** clean up any open resources */
    public void close() throws IOException;
}

