com.gs.collections.impl.bag.immutable

Class ImmutableHashBag<T>

java.lang.Object

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

com.gs.collections.impl.collection.immutable.AbstractImmutableCollection<T>

com.gs.collections.impl.bag.immutable.AbstractImmutableBag<T>

com.gs.collections.impl.bag.immutable.ImmutableHashBag<T>

All Implemented Interfaces:

com.gs.collections.api.bag.Bag<T>, com.gs.collections.api.bag.ImmutableBag<T>, com.gs.collections.api.bag.UnsortedBag<T>, com.gs.collections.api.collection.ImmutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>

public class ImmutableHashBag<T>
extends AbstractImmutableBag<T>
implements java.io.Serializable

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableHashBag()
ImmutableHashBag(com.gs.collections.api.bag.Bag<? extends T> source)
ImmutableHashBag(java.lang.Iterable<? extends T> source)

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.
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.
void	appendString(java.lang.Appendable appendable) Prints a string representation of this collection onto the given Appendable.
void	appendString(java.lang.Appendable appendable, java.lang.String separator) Prints a string representation of this collection onto the given Appendable.
void	appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end) Prints a string representation of this collection onto the given Appendable.
com.gs.collections.api.LazyIterable<T>	asLazy() Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
<V> com.gs.collections.api.bag.ImmutableBag<V>	collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
<V,R extends java.util.Collection<V>> R	collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target) Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
<V> com.gs.collections.api.bag.ImmutableBag<V>	collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
<V,R extends java.util.Collection<V>> R	collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target) Same as the collectIf method with two parameters but uses the specified target collection for the results.
<P,V,R extends java.util.Collection<V>> R	collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter, R targetCollection) Same as collectWith but with a targetCollection parameter to gather the results.
boolean	contains(java.lang.Object object) Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAllArguments(java.lang.Object... elements) Returns true if all elements in the specified var arg array are contained in this collection.
boolean	containsAllIterable(java.lang.Iterable<?> source) Returns true if all elements in source are contained in this collection.
int	count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Return the total number of elements that answer true to the specified predicate.
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.
T	detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function0<? extends T> function) Returns the first element of the iterable for which the predicate evaluates to true.
boolean	equals(java.lang.Object obj) Two bagsb1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).
<V> com.gs.collections.api.bag.ImmutableBag<V>	flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) flatCollect is a special case of RichIterable.collect(Function).
<V,R extends java.util.Collection<V>> R	flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target) Same as flatCollect, only the results are collected into the target collection.
void	forEach(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> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
void	forEachWithOccurrences(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure) For each distinct item, with the number of occurrences, execute the specified procedure.
T	getFirst() Returns the first element of an iterable.
T	getLast() Returns the last element of an iterable.
<V> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T>	groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R	groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target) Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
<V> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T>	groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R	groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target) Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
<V> com.gs.collections.api.map.ImmutableMap<V,T>	groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function) For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode() Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().
<IV> IV	injectInto(IV injectedValue, com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function) Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
boolean	isEmpty() Returns true if this iterable has zero items.
java.util.Iterator<T>	iterator()
java.lang.String	makeString() Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
java.lang.String	makeString(java.lang.String separator) Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
java.lang.String	makeString(java.lang.String start, java.lang.String separator, java.lang.String end) Returns a string representation of this collection.
T	max() Returns the maximum element out of this container based on the natural order.
T	max(java.util.Comparator<? super T> comparator) Returns the maximum element out of this container based on the comparator.
<V extends java.lang.Comparable<? super V>> T	maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
T	min() Returns the minimum element out of this container based on the natural order.
T	min(java.util.Comparator<? super T> comparator) Returns the minimum element out of this container based on the comparator.
<V extends java.lang.Comparable<? super V>> T	minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
static <T> ImmutableHashBag<T>	newBag()
static <T> ImmutableHashBag<T>	newBag(java.lang.Iterable<? extends T> source)
static <T> ImmutableHashBag<T>	newBagWith(com.gs.collections.api.bag.Bag<? extends T> bag)
static <T> ImmutableHashBag<T>	newBagWith(T... elements)
com.gs.collections.api.bag.ImmutableBag<T>	newWith(T element)
com.gs.collections.api.bag.ImmutableBag<T>	newWithAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.bag.ImmutableBag<T>	newWithout(T element)
com.gs.collections.api.bag.ImmutableBag<T>	newWithoutAll(java.lang.Iterable<? extends T> elements)
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.
boolean	notEmpty() The English equivalent of !this.isEmpty()
int	occurrencesOf(java.lang.Object item) The occurrences of a distinct item in the bag.
com.gs.collections.api.partition.bag.PartitionImmutableBag<T>	partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> com.gs.collections.api.partition.bag.PartitionImmutableBag<T>	partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into a PartitionIterable based on the evaluation of the predicate.
com.gs.collections.api.bag.ImmutableBag<T>	reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
<R extends java.util.Collection<T>> R	reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target) Same as the reject method with one parameter but uses the specified target collection for the results.
<P,R extends java.util.Collection<T>> R	rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection) Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
com.gs.collections.api.bag.ImmutableBag<T>	select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
<R extends java.util.Collection<T>> R	select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target) Same as the select method with one parameter but uses the specified target collection for the results.
com.gs.collections.api.bag.ImmutableBag<T>	selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate) Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
<S> com.gs.collections.api.bag.ImmutableBag<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P,R extends java.util.Collection<T>> R	selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection) Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
int	size() Returns the number of items in this iterable.
int	sizeDistinct() The size of the Bag when counting only distinct elements.
java.lang.Object[]	toArray() Converts this iterable to an array.
<T> T[]	toArray(T[] a) Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
com.gs.collections.api.bag.MutableBag<T>	toBag() Converts the collection to the default MutableBag implementation.
com.gs.collections.api.bag.ImmutableBag<T>	toImmutable() Converts the UnsortedBag to an ImmutableBag.
com.gs.collections.api.list.MutableList<T>	toList() Converts the collection to a MutableList implementation.
<K,V> com.gs.collections.api.map.MutableMap<K,V>	toMap(com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction, com.gs.collections.api.block.function.Function<? super T,? extends V> valueFunction) Converts the collection to a MutableMap implementation using the specified key and value functions.
com.gs.collections.api.map.MapIterable<T,java.lang.Integer>	toMapOfItemToCount() Converts the Bag to a Map of the Item type to its count as an Integer.
com.gs.collections.api.set.MutableSet<T>	toSet() Converts the collection to a MutableSet implementation.
com.gs.collections.api.list.MutableList<T>	toSortedList() Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
com.gs.collections.api.list.MutableList<T>	toSortedList(java.util.Comparator<? super T> comparator) Converts the collection to a MutableList implementation and sorts it using the specified comparator.
java.lang.String	toString() Returns a string representation of this collection.
protected java.lang.Object	writeReplace()
<S> com.gs.collections.api.bag.ImmutableBag<com.gs.collections.api.tuple.Pair<T,S>>	zip(java.lang.Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
<S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,S>>> R	zip(java.lang.Iterable<S> that, R target) Same as RichIterable.zip(Iterable) but uses target for output.
com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.
<R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>> R	zipWithIndex(R target) Same as RichIterable.zipWithIndex() but uses target for output.

Methods inherited from class com.gs.collections.impl.bag.immutable.AbstractImmutableBag

collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, collectWith, newMutable, rejectWith, selectWith, toStringOfItemToCount

Methods inherited from class com.gs.collections.impl.collection.immutable.AbstractImmutableCollection

add, addAll, aggregateBy, aggregateInPlaceBy, chunk, clear, remove, removeAll, removeAllFrom, retainAll

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

allSatisfyWith, anySatisfyWith, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, countWith, detectWith, detectWithIfNone, injectInto, injectInto, injectInto, injectInto, noneSatisfyWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

aggregateBy, aggregateInPlaceBy, allSatisfyWith, anySatisfyWith, chunk, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, countWith, detectWith, detectWithIfNone, injectInto, injectInto, injectInto, injectInto, noneSatisfyWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy

Methods inherited from interface com.gs.collections.api.collection.ImmutableCollection

aggregateBy, aggregateInPlaceBy

Methods inherited from interface java.util.Collection

containsAll

Constructor Detail

ImmutableHashBag

public ImmutableHashBag()

ImmutableHashBag

public ImmutableHashBag(java.lang.Iterable<? extends T> source)

ImmutableHashBag

public ImmutableHashBag(com.gs.collections.api.bag.Bag<? extends T> source)

Method Detail

newBag

public static <T> ImmutableHashBag<T> newBag()

newBag

public static <T> ImmutableHashBag<T> newBag(java.lang.Iterable<? extends T> source)

newBagWith

public static <T> ImmutableHashBag<T> newBagWith(T... elements)

newBagWith

public static <T> ImmutableHashBag<T> newBagWith(com.gs.collections.api.bag.Bag<? extends T> bag)

newWith

public com.gs.collections.api.bag.ImmutableBag<T> newWith(T element)

Specified by:

newWith in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

newWith in interface com.gs.collections.api.collection.ImmutableCollection<T>

newWithout

public com.gs.collections.api.bag.ImmutableBag<T> newWithout(T element)

Specified by:

newWithout in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

newWithout in interface com.gs.collections.api.collection.ImmutableCollection<T>

newWithAll

public com.gs.collections.api.bag.ImmutableBag<T> newWithAll(java.lang.Iterable<? extends T> elements)

Specified by:

newWithAll in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

newWithAll in interface com.gs.collections.api.collection.ImmutableCollection<T>

newWithoutAll

public com.gs.collections.api.bag.ImmutableBag<T> newWithoutAll(java.lang.Iterable<? extends T> elements)

Specified by:

newWithoutAll in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

newWithoutAll in interface com.gs.collections.api.collection.ImmutableCollection<T>

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>

Specified by:

size in interface java.util.Collection<T>

groupBy

public <V> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

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

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

groupBy in interface com.gs.collections.api.bag.Bag<T>

Specified by:

groupBy in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

groupBy in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

groupBy in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

groupBy

public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                                                           R target)

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

Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, new FastListMultimap<String, Person>());
 

Specified by:

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

Overrides:

groupBy in class AbstractRichIterable<T>

groupByEach

public <V> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)

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

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface com.gs.collections.api.bag.Bag<T>

Specified by:

groupByEach in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

groupByEach in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

groupByEach in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

groupByEach

public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
                                                                               R target)

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

Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.

Specified by:

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

Overrides:

groupByEach in class AbstractRichIterable<T>

groupByUniqueKey

public <V> com.gs.collections.api.map.ImmutableMap<V,T> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

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

For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

See Also:

RichIterable.groupBy(Function)

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>

Specified by:

isEmpty in interface java.util.Collection<T>

Overrides:

isEmpty in class AbstractRichIterable<T>

notEmpty

public boolean notEmpty()

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

The English equivalent of !this.isEmpty()

Specified by:

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

Overrides:

notEmpty 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.RichIterable<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>

min

public T min(java.util.Comparator<? super T> comparator)

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

Returns the minimum element out of this container based on the comparator.

Specified by:

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

Overrides:

min in class AbstractRichIterable<T>

max

public T max(java.util.Comparator<? super T> comparator)

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

Returns the maximum element out of this container based on the comparator.

Specified by:

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

Overrides:

max in class AbstractRichIterable<T>

min

public T min()

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

Returns the minimum element out of this container based on the natural order.

Specified by:

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

Overrides:

min in class AbstractRichIterable<T>

max

public T max()

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

Returns the maximum element out of this container based on the natural order.

Specified by:

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

Overrides:

max in class AbstractRichIterable<T>

minBy

public <V extends java.lang.Comparable<? super V>> T minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

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

Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

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

Overrides:

minBy in class AbstractRichIterable<T>

maxBy

public <V extends java.lang.Comparable<? super V>> T maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

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

Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

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

Overrides:

maxBy in class AbstractRichIterable<T>

contains

public boolean contains(java.lang.Object object)

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

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

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

Specified by:

contains in interface java.util.Collection<T>

Overrides:

contains in class AbstractRichIterable<T>

containsAllIterable

public boolean containsAllIterable(java.lang.Iterable<?> source)

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

Returns true if all elements in source are contained in this collection.

Specified by:

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

Overrides:

containsAllIterable in class AbstractRichIterable<T>

containsAllArguments

public boolean containsAllArguments(java.lang.Object... elements)

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

Returns true if all elements in the specified var arg array are contained in this collection.

Specified by:

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

Overrides:

containsAllArguments in class AbstractRichIterable<T>

toMap

public <K,V> com.gs.collections.api.map.MutableMap<K,V> toMap(com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction,
                                                     com.gs.collections.api.block.function.Function<? super T,? extends V> valueFunction)

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

Converts the collection to a MutableMap implementation using the specified key and value functions.

Specified by:

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

Overrides:

toMap in class AbstractRichIterable<T>

forEach

public void forEach(com.gs.collections.api.block.procedure.Procedure<? super T> 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());
     }
 });
 

Specified by:

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

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

e.g.
 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.

e.g.
 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>

selectByOccurrences

public com.gs.collections.api.bag.ImmutableBag<T> selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate)

Description copied from interface: com.gs.collections.api.bag.Bag

Returns all elements of the bag that have a number of occurrences that satisfy the predicate.

Specified by:

selectByOccurrences in interface com.gs.collections.api.bag.Bag<T>

Specified by:

selectByOccurrences in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

selectByOccurrences in interface com.gs.collections.api.bag.UnsortedBag<T>

select

public com.gs.collections.api.bag.ImmutableBag<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

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

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 

Specified by:

select in interface com.gs.collections.api.bag.Bag<T>

Specified by:

select in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

select in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

select in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

reject

public com.gs.collections.api.bag.ImmutableBag<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

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

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 

e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 

Specified by:

reject in interface com.gs.collections.api.bag.Bag<T>

Specified by:

reject in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

reject in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

reject in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

reject in interface com.gs.collections.api.RichIterable<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

partition

public com.gs.collections.api.partition.bag.PartitionImmutableBag<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

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

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

e.g.
 return people.partition(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 

Specified by:

partition in interface com.gs.collections.api.bag.Bag<T>

Specified by:

partition in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

partition in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

partition in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

Overrides:

partition in class AbstractImmutableBag<T>

partitionWith

public <P> com.gs.collections.api.partition.bag.PartitionImmutableBag<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                                              P parameter)

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

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

e.g.
 return people.partitionWith(new Predicate2<Person, String>()
 {
     public boolean accept(Person person, String state)
     {
         return person.getAddress().getState().getName().equals(state);
     }
 }, "New York");
 

Specified by:

partitionWith in interface com.gs.collections.api.bag.Bag<T>

Specified by:

partitionWith in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

partitionWith in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

Overrides:

partitionWith in class AbstractImmutableBag<T>

selectInstancesOf

public <S> com.gs.collections.api.bag.ImmutableBag<S> selectInstancesOf(java.lang.Class<S> clazz)

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

Returns all elements of the source collection that are instances of the Class clazz.

Specified by:

selectInstancesOf in interface com.gs.collections.api.bag.Bag<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

collect

public <V> com.gs.collections.api.bag.ImmutableBag<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

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

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

collect in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

collect in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

collect in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

collectIf

public <V> com.gs.collections.api.bag.ImmutableBag<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.RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).

e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 

Specified by:

collectIf in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

collectIf in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

collectIf in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

flatCollect

public <V> com.gs.collections.api.bag.ImmutableBag<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.RichIterable

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = new Function<Person, List<Address>>()
 {
     public List<Address> valueOf(Person person)
     {
         return person.getAddresses();
     }
 };
 MutableList<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 MutableList<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 MutableList<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

flatCollect in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

flatCollect in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

flatCollect in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

toList

public com.gs.collections.api.list.MutableList<T> toList()

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

Converts the collection to a MutableList implementation.

Specified by:

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

Overrides:

toList in class AbstractRichIterable<T>

sizeDistinct

public int sizeDistinct()

Description copied from interface: com.gs.collections.api.bag.Bag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface com.gs.collections.api.bag.Bag<T>

occurrencesOf

public int occurrencesOf(java.lang.Object item)

Description copied from interface: com.gs.collections.api.bag.Bag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface com.gs.collections.api.bag.Bag<T>

forEachWithOccurrences

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

Description copied from interface: com.gs.collections.api.bag.Bag

For each distinct item, with the number of occurrences, execute the specified procedure.

Specified by:

forEachWithOccurrences in interface com.gs.collections.api.bag.Bag<T>

toSortedList

public com.gs.collections.api.list.MutableList<T> toSortedList()

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

Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.

Specified by:

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

Overrides:

toSortedList in class AbstractRichIterable<T>

toSortedList

public com.gs.collections.api.list.MutableList<T> toSortedList(java.util.Comparator<? super T> comparator)

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

Converts the collection to a MutableList implementation and sorts it using the specified comparator.

Specified by:

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

Overrides:

toSortedList in class AbstractRichIterable<T>

select

public <R extends java.util.Collection<T>> R select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                           R target)

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

Same as the select method with one parameter but uses the specified target collection for the results.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 

e.g.
 return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
 

Specified by:

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

Overrides:

select in class AbstractRichIterable<T>

Parameters:

predicate - a Predicate to use as the select criteria

target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

target, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate)

selectWith

public <P,R extends java.util.Collection<T>> R selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)

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

Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.

Specified by:

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

Overrides:

selectWith in class AbstractRichIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)

reject

public <R extends java.util.Collection<T>> R reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                           R target)

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

Same as the reject method with one parameter but uses the specified target collection for the results.

e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 

Specified by:

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

Overrides:

reject in class AbstractRichIterable<T>

Parameters:

predicate - a Predicate to use as the reject criteria

target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

target, which contains appended elements as a result of the reject criteria

rejectWith

public <P,R extends java.util.Collection<T>> R rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)

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

Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has a height greater than 100cm

 return people.reject(new Predicate2<Person, Integer>()
 {
     public boolean accept(Person p, Integer i)
     {
         return p.getHeightInCm() < i.intValue();
     }
 }, Integer.valueOf(100), FastList.newList());
 

Specified by:

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

Overrides:

rejectWith in class AbstractRichIterable<T>

Parameters:

predicate - a Predicate2 to use as the reject criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

targetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

targetCollection, which contains appended elements as a result of the reject criteria

See Also:

RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)

collect

public <V,R extends java.util.Collection<V>> R collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                              R target)

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

Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, Lists.mutable.of());
 

Specified by:

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

Overrides:

collect in class AbstractRichIterable<T>

Parameters:

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

target, which contains appended elements as a result of the collect transformation

See Also:

RichIterable.collect(Function)

collectWith

public <P,V,R extends java.util.Collection<V>> R collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
                                                    P parameter,
                                                    R targetCollection)

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

Same as collectWith but with a targetCollection parameter to gather the results.

e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), UnifiedSet.newSet());
 

Specified by:

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

Overrides:

collectWith in class AbstractRichIterable<T>

Parameters:

function - a Function2 to use as the collect transformation function

parameter - a parameter to pass in for evaluation of the second argument P in function

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

targetCollection, which contains appended elements as a result of the collect transformation

flatCollect

public <V,R extends java.util.Collection<V>> R flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
                                                  R target)

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

Same as flatCollect, only the results are collected into the target collection.

Specified by:

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

Overrides:

flatCollect in class AbstractRichIterable<T>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

RichIterable.flatCollect(Function)

collectIf

public <V,R extends java.util.Collection<V>> R collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                                com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                                R target)

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

Same as the collectIf method with two parameters but uses the specified target collection for the results.

Specified by:

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

Overrides:

collectIf in class AbstractRichIterable<T>

Parameters:

predicate - a Predicate to use as the select criteria

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the collect criteria and transformation

See Also:

RichIterable.collectIf(Predicate, Function)

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.

e.g.
 return 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>

detectIfNone

public T detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
             com.gs.collections.api.block.function.Function0<? extends T> function)

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

Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.

Specified by:

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

Overrides:

detectIfNone in class AbstractRichIterable<T>

count

public int count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

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

Return the total number of elements that answer true to the specified predicate.

e.g.
 return people.count(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 

Specified by:

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

Overrides:

count in class AbstractRichIterable<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>

injectInto

public <IV> IV injectInto(IV injectedValue,
                 com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)

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

Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.

Specified by:

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

Overrides:

injectInto in class AbstractRichIterable<T>

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: com.gs.collections.api.bag.Bag

Two bagsb1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).

Specified by:

equals in interface com.gs.collections.api.bag.Bag<T>

Specified by:

equals in interface java.util.Collection<T>

Overrides:

equals in class java.lang.Object

See Also:

Map.equals(Object)

hashCode

public int hashCode()

Description copied from interface: com.gs.collections.api.bag.Bag

Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().

Specified by:

hashCode in interface com.gs.collections.api.bag.Bag<T>

Specified by:

hashCode in interface java.util.Collection<T>

Overrides:

hashCode in class java.lang.Object

See Also:

Map.hashCode()

toMapOfItemToCount

public com.gs.collections.api.map.MapIterable<T,java.lang.Integer> toMapOfItemToCount()

Description copied from interface: com.gs.collections.api.bag.Bag

Converts the Bag to a Map of the Item type to its count as an Integer.

Specified by:

toMapOfItemToCount in interface com.gs.collections.api.bag.Bag<T>

toSet

public com.gs.collections.api.set.MutableSet<T> toSet()

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

Converts the collection to a MutableSet implementation.

Specified by:

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

Overrides:

toSet in class AbstractRichIterable<T>

toBag

public com.gs.collections.api.bag.MutableBag<T> toBag()

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

Converts the collection to the default MutableBag implementation.

Specified by:

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

Overrides:

toBag in class AbstractRichIterable<T>

toImmutable

public com.gs.collections.api.bag.ImmutableBag<T> toImmutable()

Description copied from interface: com.gs.collections.api.bag.UnsortedBag

Converts the UnsortedBag to an ImmutableBag. If the bag is immutable, it returns itself.

Specified by:

toImmutable in interface com.gs.collections.api.bag.UnsortedBag<T>

asLazy

public com.gs.collections.api.LazyIterable<T> asLazy()

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

Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).

Specified by:

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

Overrides:

asLazy 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>

Specified by:

toArray in interface java.util.Collection<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray()

toArray

public <T> T[] toArray(T[] a)

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

Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

Specified by:

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

Specified by:

toArray in interface java.util.Collection<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray(Object[])

toString

public java.lang.String toString()

Description copied from class: AbstractRichIterable

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

This implementation creates an empty string buffer, appends a left square bracket, and iterates over the collection appending the string representation of each element in turn. After appending each element except the last, the string ", " is appended. Finally a right bracket is appended. A string is obtained from the string buffer, and returned.

Specified by:

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

Overrides:

toString in class AbstractRichIterable<T>

Returns:

a string representation of this collection.

makeString

public java.lang.String makeString()

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

Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

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

Overrides:

makeString in class AbstractRichIterable<T>

Returns:

a string representation of this collection.

makeString

public java.lang.String makeString(java.lang.String separator)

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

Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

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

Overrides:

makeString in class AbstractRichIterable<T>

Returns:

a string representation of this collection.

makeString

public java.lang.String makeString(java.lang.String start,
                          java.lang.String separator,
                          java.lang.String end)

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

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings as by String.valueOf(Object).

Specified by:

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

Overrides:

makeString in class AbstractRichIterable<T>

Returns:

a string representation of this collection.

appendString

public void appendString(java.lang.Appendable appendable)

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

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().

Specified by:

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

Overrides:

appendString in class AbstractRichIterable<T>

appendString

public void appendString(java.lang.Appendable appendable,
                java.lang.String separator)

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

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).

Specified by:

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

Overrides:

appendString in class AbstractRichIterable<T>

appendString

public void appendString(java.lang.Appendable appendable,
                java.lang.String start,
                java.lang.String separator,
                java.lang.String end)

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

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).

Specified by:

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

Overrides:

appendString in class AbstractRichIterable<T>

zip

public <S> com.gs.collections.api.bag.ImmutableBag<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)

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

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

zip in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

zip in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zip

public <S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,S>>> R zip(java.lang.Iterable<S> that,
                                                                               R target)

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

Same as RichIterable.zip(Iterable) but uses target for output.

Specified by:

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

Overrides:

zip in class AbstractRichIterable<T>

zipWithIndex

public com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()

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

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface com.gs.collections.api.bag.Bag<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.bag.ImmutableBag<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.bag.UnsortedBag<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

RichIterable.zip(Iterable)

zipWithIndex

public <R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>> R zipWithIndex(R target)

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

Same as RichIterable.zipWithIndex() but uses target for output.

Specified by:

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

Overrides:

zipWithIndex in class AbstractRichIterable<T>

iterator

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

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

writeReplace

protected java.lang.Object writeReplace()