uk.gov.gchq.gaffer.commonutil.iterable.RepeatItemIterable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-util Show documentation

There is a newer version: 2.3.1

/*
 * Copyright 2017-2019 Crown Copyright
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package uk.gov.gchq.gaffer.commonutil.iterable;

import java.util.Iterator;

/**
 * A {@code RepeatItemIterable} is an {@link Iterable} which contains multiple
 * copies of the same object.
 *
 * @param  the type of items in the iterable.
 */
public class RepeatItemIterable implements Iterable {
    private final long repeats;
    private final T item;

    public RepeatItemIterable(final T item, final long repeats) {
        this.item = item;
        this.repeats = repeats;
    }

    @Override
    public Iterator iterator() {
        return new RepeatItemIterator<>(item, repeats);
    }
}