com.gs.collections.impl.lazy

Class ZipIterable<X,Y>

java.lang.Object

com.gs.collections.impl.lazy.AbstractLazyIterable<com.gs.collections.api.tuple.Pair<X,Y>>

com.gs.collections.impl.lazy.ZipIterable<X,Y>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<com.gs.collections.api.tuple.Pair<X,Y>>, com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<X,Y>>, com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<X,Y>>, java.lang.Iterable<com.gs.collections.api.tuple.Pair<X,Y>>

@Immutable
public class ZipIterable<X,Y>
extends AbstractLazyIterable<com.gs.collections.api.tuple.Pair<X,Y>>

A ZipIterable is an iterable that transforms a source iterable on a condition as it iterates.

Constructor Summary

Constructors

Constructor and Description
ZipIterable(java.lang.Iterable<X> xs, java.lang.Iterable<Y> ys)

Method Summary

Methods

Modifier and Type	Method and Description
void	forEach(com.gs.collections.api.block.procedure.Procedure<? super com.gs.collections.api.tuple.Pair<X,Y>> procedure) The procedure is executed for each element in the iterable.
<P> void	forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super com.gs.collections.api.tuple.Pair<X,Y>,? super P> procedure, P parameter) The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super com.gs.collections.api.tuple.Pair<X,Y>> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
java.util.Iterator<com.gs.collections.api.tuple.Pair<X,Y>>	iterator()

Methods inherited from class com.gs.collections.impl.lazy.AbstractLazyIterable

aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, collectWith, concatenate, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, distinct, drop, flatCollect, flatCollect, getFirst, getLast, groupBy, groupBy, groupByEach, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, partition, partitionWith, reject, reject, rejectWith, rejectWith, select, select, selectInstancesOf, selectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, take, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toStack, toString, zip, zip, zipWithIndex, zipWithIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ZipIterable

public ZipIterable(java.lang.Iterable<X> xs,
           java.lang.Iterable<Y> ys)

Method Detail

iterator

public java.util.Iterator<com.gs.collections.api.tuple.Pair<X,Y>> iterator()

forEach

public void forEach(com.gs.collections.api.block.procedure.Procedure<? super com.gs.collections.api.tuple.Pair<X,Y>> procedure)

Description copied from interface: com.gs.collections.api.InternalIterable

The procedure is executed for each element in the iterable.

e.g.
 people.forEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

forEachWithIndex

public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super com.gs.collections.api.tuple.Pair<X,Y>> objectIntProcedure)

Description copied from interface: com.gs.collections.api.InternalIterable

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure

e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

forEachWith

public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super com.gs.collections.api.tuple.Pair<X,Y>,? super P> procedure,
                   P parameter)

Description copied from interface: com.gs.collections.api.InternalIterable

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

e.g.
 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);