org.cactoos.iterable.IterableEnvelope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cactoos Show documentation

Object-oriented Java Primitives

There is a newer version: 0.56.1

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2017-2018 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.cactoos.iterable;

import java.util.Iterator;
import org.cactoos.Scalar;
import org.cactoos.scalar.UncheckedScalar;

/**
 * Iterable envelope.
 *
 * There is no thread-safety guarantee.
 *
 * @author Yegor Bugayenko ([email protected])
 * @version $Id: 457a6af9ac37e38fb89f98fefe8e01c1059843a4 $
 * @param  Type of item
 * @since 0.24
 * @checkstyle AbstractClassNameCheck (500 lines)
 */
@SuppressWarnings("PMD.AbstractNaming")
public abstract class IterableEnvelope implements Iterable {

    /**
     * The iterable.
     */
    private final UncheckedScalar> iterable;

    /**
     * Ctor.
     * @param scalar The source
     */
    public IterableEnvelope(final Scalar> scalar) {
        this.iterable = new UncheckedScalar<>(scalar);
    }

    @Override
    public final Iterator iterator() {
        return this.iterable.value().iterator();
    }

}