VariantIterator.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/
 */
package org.phenotips.variantstore.input;

import java.util.Iterator;

import org.ga4gh.GAVariant;

/**
 * An iterator that returns standard GAVariant objects.
 * @version $Id: 2d3e3d6c9b54d53cbc5b7ec99cab02e0030c4f40 $
 */
public interface VariantIterator extends Iterator<GAVariant>
{
    /**
     * Get the meta information associated with the variants.
     * @return the meta info
     */
    VariantHeader getHeader();

    @Override
    boolean hasNext();

    @Override
    GAVariant next();

    @Override
    void remove();
}