IteratorWithSize.java

/*
 * Copyright (C) 2017 Dominik Schürmann <dominik@dominikschuermann.de>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.sufficientlysecure.keychain.util;

import java.util.Iterator;

/**
 * An extended iterator interface, which knows the total number of its entries beforehand.
 */
public interface IteratorWithSize<E> extends Iterator<E> {

    /**
     * Returns the total number of entries in this iterator.
     *
     * @return the number of entries in this iterator.
     */
    int getSize();

}