com.gs.collections.impl.lazy.TapIterable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gs-collections Show documentation

GS Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API and set of utility classes that work with any JDK compatible Collections, Arrays, Maps or Strings. The iteration protocol was inspired by the Smalltalk collection framework.

There is a newer version: 7.0.3

Show newest version

/*
 * Copyright 2015 Goldman Sachs.
 *
 * 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 com.gs.collections.impl.lazy;

import java.util.Iterator;

import com.gs.collections.api.block.predicate.Predicate;
import com.gs.collections.api.block.procedure.Procedure;
import com.gs.collections.api.block.procedure.Procedure2;
import com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure;
import com.gs.collections.impl.lazy.iterator.TapIterator;
import com.gs.collections.impl.utility.Iterate;
import net.jcip.annotations.Immutable;

/**
 * A TapIterable is an iterable that executes a procedure for each element before each iteration.
 */
@Immutable
public class TapIterable
        extends AbstractLazyIterable
{
    private final Iterable adapted;
    private final Procedure procedure;

    public TapIterable(Iterable newAdapted, Procedure procedure)
    {
        this.adapted = newAdapted;
        this.procedure = procedure;
    }

    public void each(final Procedure procedure)
    {
        Iterate.forEach(this.adapted, new Procedure()
        {
            public void value(T each)
            {
                TapIterable.this.procedure.value(each);
                procedure.value(each);
            }
        });
    }

    @Override
    public void forEachWithIndex(final ObjectIntProcedure objectIntProcedure)
    {
        Iterate.forEachWithIndex(this.adapted, new ObjectIntProcedure()
        {
            public void value(T each, int index)
            {
                TapIterable.this.procedure.value(each);
                objectIntProcedure.value(each, index);
            }
        });
    }

    @Override
    public  void forEachWith(final Procedure2 procedure, P parameter)
    {
        Iterate.forEachWith(this.adapted, new Procedure2()
        {
            public void value(T each, P aParameter)
            {
                TapIterable.this.procedure.value(each);
                procedure.value(each, aParameter);
            }
        }, parameter);
    }

    @Override
    public boolean anySatisfy(final Predicate predicate)
    {
        return Iterate.anySatisfy(this.adapted, new Predicate()
        {
            public boolean accept(T each)
            {
                TapIterable.this.procedure.value(each);
                return predicate.accept(each);
            }
        });
    }

    @Override
    public boolean allSatisfy(final Predicate predicate)
    {
        return Iterate.allSatisfy(this.adapted, new Predicate()
        {
            public boolean accept(T each)
            {
                TapIterable.this.procedure.value(each);
                return predicate.accept(each);
            }
        });
    }

    @Override
    public boolean noneSatisfy(final Predicate predicate)
    {
        return Iterate.noneSatisfy(this.adapted, new Predicate()
        {
            public boolean accept(T each)
            {
                TapIterable.this.procedure.value(each);
                return predicate.accept(each);
            }
        });
    }

    @Override
    public T getFirst()
    {
        return Iterate.detect(this.adapted, new Predicate()
        {
            public boolean accept(T each)
            {
                TapIterable.this.procedure.value(each);
                return true;
            }
        });
    }

    @Override
    public T detect(final Predicate predicate)
    {
        return Iterate.detect(this.adapted, new Predicate()
        {
            public boolean accept(T each)
            {
                TapIterable.this.procedure.value(each);
                return predicate.accept(each);
            }
        });
    }


    public Iterator iterator()
    {
        return new TapIterator(this.adapted, this.procedure);
    }
}