com.gs.collections.impl.lazy

Class TakeIterable<T>

java.lang.Object

com.gs.collections.impl.AbstractRichIterable<T>

com.gs.collections.impl.lazy.AbstractLazyIterable<T>

com.gs.collections.impl.lazy.TakeIterable<T>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.LazyIterable<T>, com.gs.collections.api.RichIterable<T>, java.lang.Iterable<T>

@Immutable
public class TakeIterable<T>
extends AbstractLazyIterable<T>

Iterates over the first count elements of the adapted Iterable or the full size of the adapted iterable if the count is greater than the length of the receiver.

Constructor Summary

Constructors

Constructor and Description
TakeIterable(java.lang.Iterable<T> newAdapted, int count)

Method Summary

Methods

Modifier and Type	Method and Description
void	each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure) The procedure is executed for each element in the iterable.
<P> void	forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? 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 T> procedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
java.util.Iterator<T>	iterator()
java.lang.Object[]	toArray() Converts this iterable to an array.

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

aggregateBy, aggregateInPlaceBy, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, concatenate, distinct, drop, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, into, isEmpty, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, size, take, tap, toArray, toStack, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.AbstractRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gs.collections.api.RichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach

Constructor Detail

TakeIterable

public TakeIterable(java.lang.Iterable<T> newAdapted,
            int count)

Method Detail

each

public void each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

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

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

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

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable#forEach(java.util.function.Consumer).

See Also:

InternalIterable.forEach(Procedure), Iterable#forEach(java.util.function.Consumer)

forEachWithIndex

public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> procedure)

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.

Example using a Java 8 lambda:

 people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Example using an anonymous inner class:

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

Specified by:

forEachWithIndex in interface com.gs.collections.api.InternalIterable<T>

Overrides:

forEachWithIndex in class AbstractRichIterable<T>

forEachWith

public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? 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.

Example using a Java 8 lambda:

 people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);
 

Example using an anonymous inner class:

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

Specified by:

forEachWith in interface com.gs.collections.api.InternalIterable<T>

Overrides:

forEachWith in class AbstractRichIterable<T>

toArray

public java.lang.Object[] toArray()

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

Converts this iterable to an array.

Specified by:

toArray in interface com.gs.collections.api.RichIterable<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray()

iterator

public java.util.Iterator<T> iterator()