LazyIterableAdapter (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.AbstractRichIterable<T>
- - com.gs.collections.impl.lazy.AbstractLazyIterable<T>
 - - com.gs.collections.impl.lazy.LazyIterableAdapter<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 LazyIterableAdapter<T>
extends AbstractLazyIterable<T>
```
A LazyIterableAdapter wraps any iterable with the LazyIterable interface.

Constructor Summary

Constructors
Constructor and Description

LazyIterableAdapter(java.lang.Iterable<T> newAdapted)

Constructors
Constructor and Description
`LazyIterableAdapter(java.lang.Iterable<T> newAdapted)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
`<P> boolean`	`allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns true if the predicate evaluates to true for every element of the collection, or returns false.
`boolean`	`anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns true if the predicate evaluates to true for any element of the iterable.
`<P> boolean`	`anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns true if the predicate evaluates to true for any element of the collection, or return false.
`<V> com.gs.collections.api.LazyIterable<V>`	`collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Creates a deferred iterable for collecting elements from the current iterable.
`<V> com.gs.collections.api.LazyIterable<V>`	`collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Creates a deferred iterable for selecting and collecting elements from the current iterable.
`T`	`detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
`<P> T`	`detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
`com.gs.collections.api.LazyIterable<T>`	`distinct()` Creates a deferred distinct iterable to get distinct elements from the current iterable.
`com.gs.collections.api.LazyIterable<T>`	`drop(int count)` Creates a deferred drop iterable for the current iterable using the specified count as the limit.
`void`	`each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)` The procedure is executed for each element in the iterable.
`<V> com.gs.collections.api.LazyIterable<V>`	`flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)` Creates a deferred flattening iterable for the current 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> objectIntProcedure)` Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
`T`	`getFirst()` Returns the first element of an iterable.
`T`	`getLast()` Returns the last element of an iterable.
`<R extends java.util.Collection<T>> R`	`into(R target)` Iterates over this iterable adding all elements into the target collection.
`boolean`	`isEmpty()` Returns true if this iterable has zero items.
`java.util.Iterator<T>`	`iterator()`
`boolean`	`noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
`<P> boolean`	`noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns true if the predicate evaluates to false for every element of the collection, or return false.
`com.gs.collections.api.LazyIterable<T>`	`reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Creates a deferred iterable for rejecting elements from the current iterable.
`com.gs.collections.api.LazyIterable<T>`	`select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Creates a deferred iterable for selecting elements from the current iterable.
`int`	`size()` Returns the number of items in this iterable.
`com.gs.collections.api.LazyIterable<T>`	`take(int count)` Creates a deferred take iterable for the current iterable using the specified count as the limit.
`java.lang.Object[]`	`toArray()` Converts this iterable to an array.

Methods inherited from class com.gs.collections.impl.lazy.AbstractLazyIterable
aggregateBy, aggregateInPlaceBy, asLazy, chunk, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, collectWith, concatenate, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, rejectWith, selectInstancesOf, selectWith, tap, toArray, toStack, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.AbstractRichIterable
appendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detectIfNone, detectWithIfNone, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, 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
appendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detectIfNone, detectWithIfNone, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, 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
 - LazyIterableAdapter
```
public LazyIterableAdapter(java.lang.Iterable<T> newAdapted)
```
- 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> 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.
 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  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>
 - iterator
```
public java.util.Iterator<T> iterator()
```
 - into
```
public <R extends java.util.Collection<T>> R into(R target)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Iterates over this iterable adding all elements into the target collection.
 
 Specified by:
 
 into in interface com.gs.collections.api.LazyIterable<T>
 
 Overrides:
 
 into in class AbstractLazyIterable<T>
 - select
```
public com.gs.collections.api.LazyIterable<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred iterable for selecting elements from the current iterable.
 
 Specified by:
 
 select in interface com.gs.collections.api.LazyIterable<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 select in class AbstractLazyIterable<T>
 - reject
```
public com.gs.collections.api.LazyIterable<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred iterable for rejecting elements from the current iterable.
 
 Specified by:
 
 reject in interface com.gs.collections.api.LazyIterable<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 reject in class AbstractLazyIterable<T>
 
 Parameters:
 predicate - a Predicate to use as the reject criteria
 
 Returns:
 a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false
 - collect
```
public <V> com.gs.collections.api.LazyIterable<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred iterable for collecting elements from the current iterable.
 
 Specified by:
 
 collect in interface com.gs.collections.api.LazyIterable<T>
 
 Specified by:
 
 collect in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 collect in class AbstractLazyIterable<T>
 - flatCollect
```
public <V> com.gs.collections.api.LazyIterable<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred flattening iterable for the current iterable.
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.LazyIterable<T>
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 flatCollect in class AbstractLazyIterable<T>
 
 Parameters:
 function - The Function to apply
 
 Returns:
 a new flattened collection produced by applying the given function
 - collectIf
```
public <V> com.gs.collections.api.LazyIterable<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
 com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred iterable for selecting and collecting elements from the current iterable.
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.LazyIterable<T>
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 collectIf in class AbstractLazyIterable<T>
 - take
```
public com.gs.collections.api.LazyIterable<T> take(int count)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred take iterable for the current iterable using the specified count as the limit.
 
 Specified by:
 
 take in interface com.gs.collections.api.LazyIterable<T>
 
 Overrides:
 
 take in class AbstractLazyIterable<T>
 - drop
```
public com.gs.collections.api.LazyIterable<T> drop(int count)
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred drop iterable for the current iterable using the specified count as the limit.
 
 Specified by:
 
 drop in interface com.gs.collections.api.LazyIterable<T>
 
 Overrides:
 
 drop in class AbstractLazyIterable<T>
 - distinct
```
public com.gs.collections.api.LazyIterable<T> distinct()
```
 Description copied from interface: com.gs.collections.api.LazyIterable
 
 Creates a deferred distinct iterable to get distinct elements from the current iterable.
 
 Specified by:
 
 distinct in interface com.gs.collections.api.LazyIterable<T>
 
 Overrides:
 
 distinct in class AbstractLazyIterable<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()
 - size
```
public int size()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the number of items in this iterable.
 
 Specified by:
 
 size in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 size in class AbstractLazyIterable<T>
 - isEmpty
```
public boolean isEmpty()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if this iterable has zero items.
 
 Specified by:
 
 isEmpty in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 isEmpty in class AbstractLazyIterable<T>
 - anySatisfy
```
public boolean anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.
 
 Specified by:
 
 anySatisfy in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 anySatisfy in class AbstractRichIterable<T>
 - allSatisfy
```
public boolean allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.
 
 Specified by:
 
 allSatisfy in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 allSatisfy in class AbstractRichIterable<T>
 - noneSatisfy
```
public boolean noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.
 
 Specified by:
 
 noneSatisfy in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 noneSatisfy in class AbstractRichIterable<T>
 - anySatisfyWith
```
public  boolean anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.
 
 Specified by:
 
 anySatisfyWith in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 anySatisfyWith in class AbstractRichIterable<T>
 - allSatisfyWith
```
public  boolean allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for every element of the collection, or returns false.
 
 Specified by:
 
 allSatisfyWith in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 allSatisfyWith in class AbstractRichIterable<T>
 - noneSatisfyWith
```
public  boolean noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.
 
 Specified by:
 
 noneSatisfyWith in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 noneSatisfyWith in class AbstractRichIterable<T>
 - getFirst
```
public T getFirst()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
 The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.
 
 Specified by:
 
 getFirst in interface com.gs.collections.api.LazyIterable<T>
 
 Specified by:
 
 getFirst in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 getFirst in class AbstractLazyIterable<T>
 - getLast
```
public T getLast()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
 The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.
 
 Specified by:
 
 getLast in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 getLast in class AbstractLazyIterable<T>
 - detect
```
public T detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.
 Example using a Java 8 lambda expression:
```
 Person person =
 people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 
```
 Example using an anonymous inner class:
```
 Person person =
 people.detect(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
 }
 });
 
```
 Specified by:
 
 detect in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 detect in class AbstractRichIterable<T>
 - detectWith
```
public  T detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
 Example using a Java 8 lambda expression:
```
 Person person =
 people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 
```
 Example using an anonymous inner class:
```
 Person person =
 people.detectWith(new Predicate2<Person, String>()
 {
 public boolean value(Person person, String fullName)
 {
 return person.getFullName().equals(fullName);
 }
 }, "John Smith");
 
```
 Specified by:
 
 detectWith in interface com.gs.collections.api.RichIterable<T>
 
 Overrides:
 
 detectWith in class AbstractRichIterable<T>

Class LazyIterableAdapter<T>

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

LazyIterableAdapter

Method Detail

each

forEachWithIndex

forEachWith

iterator

into

select

reject

collect

flatCollect

collectIf

take

drop

distinct

toArray

size

isEmpty

anySatisfy

allSatisfy

noneSatisfy

anySatisfyWith

allSatisfyWith

noneSatisfyWith

getFirst

getLast

detect

detectWith