fr.cenotelie.commons.utils.collections.AdaptingIterator Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2016 Association Cénotélie (cenotelie.fr)
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this program.
 * If not, see .
 ******************************************************************************/

package fr.cenotelie.commons.utils.collections;

import java.util.Iterator;

/**
 * Represents an iterator that adapts the elements of another iterator
 *
 * @param  The type of elements to iterator over
 * @param  The type of input elements
 * @author Laurent Wouters
 */
public class AdaptingIterator implements Iterator {
    /**
     * The innner iterator
     */
    protected final Iterator content;
    /**
     * The adapter for translating the element
     */
    protected final Adapter adapter;

    /**
     * Initializes this iterator
     *
     * @param content The inner iterator
     * @param adapter The adapter to use
     */
    public AdaptingIterator(Iterator content, Adapter adapter) {
        this.content = content;
        this.adapter = adapter;
    }

    @Override
    public boolean hasNext() {
        return content.hasNext();
    }

    @Override
    public T next() {
        return adapter.adapt(content.next());
    }

    @Override
    public void remove() {
        content.remove();
    }
}