com.gs.collections.impl.set.immutable

Class AbstractImmutableSet<T>

java.lang.Object

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

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

com.gs.collections.impl.set.immutable.AbstractImmutableSet<T>

All Implemented Interfaces:

com.gs.collections.api.collection.ImmutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, com.gs.collections.api.set.ImmutableSet<T>, com.gs.collections.api.set.SetIterable<T>, com.gs.collections.api.set.UnsortedSetIterable<T>, java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>

@Immutable
public abstract class AbstractImmutableSet<T>
extends AbstractImmutableCollection<T>
implements com.gs.collections.api.set.ImmutableSet<T>, java.util.Set<T>

This class is the parent class for all ImmutableLists. All implementations of ImmutableList must implement the List interface so anArrayList.equals(anImmutableList) can return true when the contents and order are the same.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractImmutableSet.ImmutableSetIterator

Constructor Summary

Constructors

Constructor and Description
AbstractImmutableSet()

Method Summary

Methods

Modifier and Type	Method and Description
<B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>>	cartesianProduct(com.gs.collections.api.set.SetIterable<B> set) Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
java.util.Set<T>	castToSet()
<V> com.gs.collections.api.set.ImmutableSet<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.
com.gs.collections.api.set.primitive.ImmutableBooleanSet	collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction) Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.ImmutableByteSet	collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction) Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.ImmutableCharSet	collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction) Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.ImmutableDoubleSet	collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction) Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.ImmutableFloatSet	collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction) Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<V> com.gs.collections.api.set.ImmutableSet<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.
com.gs.collections.api.set.primitive.ImmutableIntSet	collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction) Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.ImmutableLongSet	collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction) Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.set.primitive.ImmutableShortSet	collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction) Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<P,V> com.gs.collections.api.set.ImmutableSet<V>	collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter) Same as collect with a Function2 and specified parameter which is passed to the block
com.gs.collections.api.set.ImmutableSet<T>	difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet) Returns the set of all members of this that are not members of subtrahendSet.
<R extends java.util.Set<T>> R	differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet, R targetSet) Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.
<V> com.gs.collections.api.set.ImmutableSet<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).
abstract T	getFirst() Returns the first element of an iterable.
abstract T	getLast() Returns the last element of an iterable.
<V> com.gs.collections.api.multimap.set.ImmutableSetMultimap<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.set.ImmutableSetMultimap<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.
com.gs.collections.api.set.ImmutableSet<T>	intersect(com.gs.collections.api.set.SetIterable<? extends T> set) Returns the set of all objects that are members of both this and set.
<R extends java.util.Set<T>> R	intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet) Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.
boolean	isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset) Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal.
boolean	isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset) Returns true if all the members of this are also members of candidateSuperset.
protected com.gs.collections.api.collection.MutableCollection<T>	newMutable(int size)
com.gs.collections.api.set.ImmutableSet<T>	newWith(T element)
com.gs.collections.api.set.ImmutableSet<T>	newWithAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.set.ImmutableSet<T>	newWithout(T element)
com.gs.collections.api.set.ImmutableSet<T>	newWithoutAll(java.lang.Iterable<? extends T> elements)
protected int	nullSafeHashCode(java.lang.Object element)
com.gs.collections.api.partition.set.PartitionImmutableSet<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.set.PartitionImmutableSet<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.set.ImmutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>>	powerSet() Returns the set whose members are all possible subsets of this.
com.gs.collections.api.set.ImmutableSet<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.
<P> com.gs.collections.api.set.ImmutableSet<T>	rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
com.gs.collections.api.set.ImmutableSet<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.
<S> com.gs.collections.api.set.ImmutableSet<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> com.gs.collections.api.set.ImmutableSet<T>	selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
com.gs.collections.api.set.ImmutableSet<T>	symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB) Returns the set of all objects that are a member of exactly one of this and setB (elements which are in one of the sets, but not in both).
<R extends java.util.Set<T>> R	symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet) Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.
com.gs.collections.api.set.ImmutableSet<T>	toImmutable() Converts the UnsortedSetIterable to an immutable implementation.
com.gs.collections.api.set.ImmutableSet<T>	union(com.gs.collections.api.set.SetIterable<? extends T> set) Returns the set of all objects that are a member of this or set or both.
<R extends java.util.Set<T>> R	unionInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet) Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.
<S> com.gs.collections.api.set.ImmutableSet<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.
com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

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

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEachWith, forEachWithIndex, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, 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.collection.ImmutableCollection

aggregateBy, aggregateInPlaceBy

Methods inherited from interface com.gs.collections.api.set.SetIterable

equals, hashCode

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

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

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Constructor Detail

AbstractImmutableSet

public AbstractImmutableSet()

Method Detail

castToSet

public java.util.Set<T> castToSet()

Specified by:

castToSet in interface com.gs.collections.api.set.ImmutableSet<T>

nullSafeHashCode

protected int nullSafeHashCode(java.lang.Object element)

newWith

public com.gs.collections.api.set.ImmutableSet<T> newWith(T element)

Specified by:

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

Specified by:

newWith in interface com.gs.collections.api.set.ImmutableSet<T>

newWithout

public com.gs.collections.api.set.ImmutableSet<T> newWithout(T element)

Specified by:

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

Specified by:

newWithout in interface com.gs.collections.api.set.ImmutableSet<T>

newWithAll

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

Specified by:

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

Specified by:

newWithAll in interface com.gs.collections.api.set.ImmutableSet<T>

newWithoutAll

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

Specified by:

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

Specified by:

newWithoutAll in interface com.gs.collections.api.set.ImmutableSet<T>

getFirst

public abstract 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 abstract 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>

select

public com.gs.collections.api.set.ImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

select in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

select in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

select in interface com.gs.collections.api.set.UnsortedSetIterable<T>

selectWith

public <P> com.gs.collections.api.set.ImmutableSet<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                        P parameter)

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

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

Specified by:

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

Specified by:

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

Specified by:

selectWith in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

selectWith in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

selectWith in interface com.gs.collections.api.set.UnsortedSetIterable<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

See Also:

RichIterable.select(Predicate)

reject

public com.gs.collections.api.set.ImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

reject in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

reject in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

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

rejectWith

public <P> com.gs.collections.api.set.ImmutableSet<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                        P parameter)

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

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

Specified by:

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

Specified by:

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

Specified by:

rejectWith in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

rejectWith in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

rejectWith in interface com.gs.collections.api.set.UnsortedSetIterable<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

See Also:

RichIterable.select(Predicate)

partition

public com.gs.collections.api.partition.set.PartitionImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

partition in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

partition in interface com.gs.collections.api.set.SetIterable<T>

partitionWith

public <P> com.gs.collections.api.partition.set.PartitionImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

partitionWith in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

partitionWith in interface com.gs.collections.api.set.SetIterable<T>

selectInstancesOf

public <S> com.gs.collections.api.set.ImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

selectInstancesOf in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collect

public <V> com.gs.collections.api.set.ImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

collect in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collect in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectBoolean

public com.gs.collections.api.set.primitive.ImmutableBooleanSet collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)

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

Returns a new primitive boolean iterable 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.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectBoolean in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectBoolean in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectByte

public com.gs.collections.api.set.primitive.ImmutableByteSet collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)

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

Returns a new primitive byte iterable 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.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectByte in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectByte in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectChar

public com.gs.collections.api.set.primitive.ImmutableCharSet collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)

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

Returns a new primitive char iterable 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.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectChar in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectChar in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectDouble

public com.gs.collections.api.set.primitive.ImmutableDoubleSet collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)

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

Returns a new primitive double iterable 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.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectDouble in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectDouble in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectFloat

public com.gs.collections.api.set.primitive.ImmutableFloatSet collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)

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

Returns a new primitive float iterable 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.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectFloat in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectFloat in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectInt

public com.gs.collections.api.set.primitive.ImmutableIntSet collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)

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

Returns a new primitive int iterable 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.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectInt in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectInt in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectLong

public com.gs.collections.api.set.primitive.ImmutableLongSet collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)

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

Returns a new primitive long iterable 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.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectLong in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectLong in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectShort

public com.gs.collections.api.set.primitive.ImmutableShortSet collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)

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

Returns a new primitive short iterable 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.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectShort in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectShort in interface com.gs.collections.api.set.UnsortedSetIterable<T>

collectWith

public <P,V> com.gs.collections.api.set.ImmutableSet<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
                                                           P parameter)

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

Same as collect with a Function2 and specified parameter which is passed to the block

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));
 

Specified by:

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

Specified by:

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

Specified by:

collectWith in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectWith in interface com.gs.collections.api.set.UnsortedSetIterable<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

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

RichIterable.collect(Function)

collectIf

public <V> com.gs.collections.api.set.ImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

collectIf in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

collectIf in interface com.gs.collections.api.set.UnsortedSetIterable<T>

flatCollect

public <V> com.gs.collections.api.set.ImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

flatCollect in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

flatCollect in interface com.gs.collections.api.set.UnsortedSetIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

toImmutable

public com.gs.collections.api.set.ImmutableSet<T> toImmutable()

Description copied from interface: com.gs.collections.api.set.UnsortedSetIterable

Converts the UnsortedSetIterable to an immutable implementation. Returns this for immutable sets.

Specified by:

toImmutable in interface com.gs.collections.api.set.UnsortedSetIterable<T>

groupBy

public <V> com.gs.collections.api.multimap.set.ImmutableSetMultimap<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

groupBy in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

groupBy in interface com.gs.collections.api.set.UnsortedSetIterable<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.set.ImmutableSetMultimap<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

groupByEach in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

groupByEach in interface com.gs.collections.api.set.UnsortedSetIterable<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)

zip

public <S> com.gs.collections.api.set.ImmutableSet<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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

zip in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

zip in interface com.gs.collections.api.set.UnsortedSetIterable<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.

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.collection.ImmutableCollection<T>

Specified by:

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

Specified by:

zipWithIndex in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.set.UnsortedSetIterable<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)

newMutable

protected com.gs.collections.api.collection.MutableCollection<T> newMutable(int size)

Specified by:

newMutable in class AbstractImmutableCollection<T>

union

public com.gs.collections.api.set.ImmutableSet<T> union(com.gs.collections.api.set.SetIterable<? extends T> set)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns the set of all objects that are a member of this or set or both. The union of [1, 2, 3] and [2, 3, 4] is the set [1, 2, 3, 4]. If equal elements appear in both sets, then the output will contain the copy from this.

Specified by:

union in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

union in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

union in interface com.gs.collections.api.set.UnsortedSetIterable<T>

unionInto

public <R extends java.util.Set<T>> R unionInto(com.gs.collections.api.set.SetIterable<? extends T> set,
                                       R targetSet)

Description copied from interface: com.gs.collections.api.set.SetIterable

Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

unionInto in interface com.gs.collections.api.set.SetIterable<T>

intersect

public com.gs.collections.api.set.ImmutableSet<T> intersect(com.gs.collections.api.set.SetIterable<? extends T> set)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns the set of all objects that are members of both this and set. The intersection of [1, 2, 3] and [2, 3, 4] is the set [2, 3]. The output will contain instances from this, not set.

Specified by:

intersect in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

intersect in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

intersect in interface com.gs.collections.api.set.UnsortedSetIterable<T>

intersectInto

public <R extends java.util.Set<T>> R intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set,
                                           R targetSet)

Description copied from interface: com.gs.collections.api.set.SetIterable

Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

intersectInto in interface com.gs.collections.api.set.SetIterable<T>

difference

public com.gs.collections.api.set.ImmutableSet<T> difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns the set of all members of this that are not members of subtrahendSet. The difference of [1, 2, 3] and [2, 3, 4] is [1].

Specified by:

difference in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

difference in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

difference in interface com.gs.collections.api.set.UnsortedSetIterable<T>

differenceInto

public <R extends java.util.Set<T>> R differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet,
                                            R targetSet)

Description copied from interface: com.gs.collections.api.set.SetIterable

Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

differenceInto in interface com.gs.collections.api.set.SetIterable<T>

symmetricDifference

public com.gs.collections.api.set.ImmutableSet<T> symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns the set of all objects that are a member of exactly one of this and setB (elements which are in one of the sets, but not in both). For instance, for the sets [1, 2, 3] and [2, 3, 4], the symmetric difference set is [1, 4] . It is the set difference of the union and the intersection.

Specified by:

symmetricDifference in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

symmetricDifference in interface com.gs.collections.api.set.SetIterable<T>

Specified by:

symmetricDifference in interface com.gs.collections.api.set.UnsortedSetIterable<T>

symmetricDifferenceInto

public <R extends java.util.Set<T>> R symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set,
                                                     R targetSet)

Description copied from interface: com.gs.collections.api.set.SetIterable

Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

symmetricDifferenceInto in interface com.gs.collections.api.set.SetIterable<T>

isSubsetOf

public boolean isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns true if all the members of this are also members of candidateSuperset. For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.

Specified by:

isSubsetOf in interface com.gs.collections.api.set.SetIterable<T>

isProperSubsetOf

public boolean isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal. For example, [1, 2] is a proper subset of [1, 2, 3], but [1, 2, 3] is not.

Specified by:

isProperSubsetOf in interface com.gs.collections.api.set.SetIterable<T>

powerSet

public com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>> powerSet()

Description copied from interface: com.gs.collections.api.set.UnsortedSetIterable

Returns the set whose members are all possible subsets of this. For example, the powerset of [1, 2] is [[], [1], [2], [1, 2]].

Specified by:

powerSet in interface com.gs.collections.api.set.ImmutableSet<T>

Specified by:

powerSet in interface com.gs.collections.api.set.UnsortedSetIterable<T>

cartesianProduct

public <B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>> cartesianProduct(com.gs.collections.api.set.SetIterable<B> set)

Description copied from interface: com.gs.collections.api.set.SetIterable

Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.

Specified by:

cartesianProduct in interface com.gs.collections.api.set.SetIterable<T>