/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 Yegor Bugayenko
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.takes.misc;

import java.util.Iterator;

/**
 * Verbose iterable.
 *
 * @author Yegor Bugayenko (yegor256@gmail.com)
 * @version $Id: 01ea7528d1d44f0c3d47476e381345f4098d9591 $
 * @param <T> Type of item
 * @since 0.10
 */
public final class VerboseIterable<T> implements Iterable<T> {

    /**
     * Original iterator.
     */
    private final Iterable<T> origin;

    /**
     * Error message when running out of items.
     */
    private final CharSequence error;

    /**
     * Ctor.
     * @param iter Original iterator
     * @param msg Error message
     */
    public VerboseIterable(final Iterable<T> iter, final CharSequence msg) {
        this.origin = iter;
        this.error = msg;
    }

    @Override
    public Iterator<T> iterator() {
        return new VerboseIterator<T>(this.origin.iterator(), this.error);
    }
}