Class AbstractImmutableSortedSet<T>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<T>

org.eclipse.collections.impl.collection.immutable.AbstractImmutableCollection<T>

org.eclipse.collections.impl.set.sorted.immutable.AbstractImmutableSortedSet<T>

All Implemented Interfaces:

Comparable<SortedSetIterable<T>>, Iterable<T>, Collection<T>, SequencedCollection<T>, SequencedSet<T>, Set<T>, SortedSet<T>, ImmutableCollection<T>, InternalIterable<T>, OrderedIterable<T>, ReversibleIterable<T>, SortedIterable<T>, RichIterable<T>, ImmutableSetIterable<T>, SetIterable<T>, ImmutableSortedSet<T>, SortedSetIterable<T>

Direct Known Subclasses:

ImmutableEmptySortedSet, ImmutableTreeSet

abstract class AbstractImmutableSortedSet<T>
extends AbstractImmutableCollection<T>
implements ImmutableSortedSet<T>, SortedSet<T>

This class is the parent class for all ImmutableSortedSets. All implementations of ImmutableSortedSet must implement the SortedSet interface so an TreeSet.equals(anImmutableSortedSet) can return true when the contents are the same.

Constructor Summary

Constructors

Constructor	Description
AbstractImmutableSortedSet()

Method Summary

Modifier and Type	Method	Description
ParallelSortedSetIterable<T>	asParallel(ExecutorService executorService, int batchSize)	Returns a parallel iterable of this SortedSetIterable.
<B> LazyIterable<Pair<T,B>>	cartesianProduct(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.
SortedSet<T>	castToSortedSet()
<V> ImmutableList<V>	collect(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.
ImmutableBooleanList	collectBoolean(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.
ImmutableByteList	collectByte(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.
ImmutableCharList	collectChar(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.
ImmutableDoubleList	collectDouble(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.
ImmutableFloatList	collectFloat(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> ImmutableList<V>	collectIf(Predicate<? super T> predicate, 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.
ImmutableIntList	collectInt(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.
ImmutableLongList	collectLong(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.
ImmutableShortList	collectShort(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> ImmutableList<V>	collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super T, ? super S> predicate)	Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
int	detectIndex(Predicate<? super T> predicate)	Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
int	detectLastIndex(Predicate<? super T> predicate)	Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true.
ImmutableSortedSet<T>	difference(SetIterable<? extends T> subtrahendSet)	Returns the set of all members of this that are not members of subtrahendSet.
<R extends Set<T>> R	differenceInto(SetIterable<? extends T> subtrahendSet, R targetSet)	Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.
ImmutableSortedSet<T>	distinct()	Returns a new SortedIterable containing the distinct elements in this iterable.
ImmutableSortedSet<T>	dropWhile(Predicate<? super T> predicate)	Returns the final elements that do not satisfy the Predicate.
<V> ImmutableList<V>	flatCollect(Function<? super T, ? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
T	getFirst()	Returns the first element of an iterable.
T	getLast()	Returns the last element of an iterable.
<V> ImmutableSortedSetMultimap<V,T>	groupBy(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> ImmutableSortedSetMultimap<V,T>	groupByEach(Function<? super T, ? extends Iterable<V>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
SortedSet<T>	headSet(T toElement)
ImmutableSortedSet<T>	intersect(SetIterable<? extends T> set)	Returns the set of all objects that are members of both this and set.
<R extends Set<T>> R	intersectInto(SetIterable<? extends T> set, R targetSet)	Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.
boolean	isProperSubsetOf(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(SetIterable<? extends T> candidateSuperset)	Returns true if all the members of this are also members of candidateSuperset.
protected MutableCollection<T>	newMutable(int size)
ImmutableSortedSet<T>	newWith(T element)	This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.
ImmutableSortedSet<T>	newWithAll(Iterable<? extends T> elements)	This method is similar to the withAll method in MutableCollection with the difference that a new copy of this collection with the elements appended will be returned.
ImmutableSortedSet<T>	newWithout(T element)	This method is similar to the without method in MutableCollection with the difference that a new copy of this collection with the element removed will be returned.
ImmutableSortedSet<T>	newWithoutAll(Iterable<? extends T> elements)	This method is similar to the withoutAll method in MutableCollection with the difference that a new copy of this collection with the elements removed will be returned.
PartitionImmutableSortedSet<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
PartitionImmutableSortedSet<T>	partitionWhile(Predicate<? super T> predicate)	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> PartitionImmutableSortedSet<T>	partitionWith(Predicate2<? super T, ? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
ImmutableSortedSet<SortedSetIterable<T>>	powerSet()	Returns the set whose members are all possible subsets of this.
ImmutableSortedSet<T>	reject(Predicate<? super T> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<P> ImmutableSortedSet<T>	rejectWith(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.
ImmutableSortedSet<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<S> ImmutableSortedSet<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> ImmutableSortedSet<T>	selectWith(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.
SortedSet<T>	subSet(T fromElement, T toElement)
ImmutableSortedSet<T>	symmetricDifference(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 Set<T>> R	symmetricDifferenceInto(SetIterable<? extends T> set, R targetSet)	Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.
SortedSet<T>	tailSet(T fromElement)
ImmutableSortedSet<T>	takeWhile(Predicate<? super T> predicate)	Returns the initial elements that satisfy the Predicate.
ImmutableSortedSet<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
ImmutableSortedSet<T>	toImmutable()	Converts the SortedSetIterable to an immutable implementation.
ImmutableSortedSet<T>	toReversed()	Returns a new ReversibleIterable in reverse order.
MutableStack<T>	toStack()	Converts the OrderedIterable to a mutable MutableStack implementation.
ImmutableSortedSet<T>	union(SetIterable<? extends T> set)	Returns the set of all objects that are a member of this or set or both.
<R extends Set<T>> R	unionInto(SetIterable<? extends T> set, R targetSet)	Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.
<S> ImmutableList<Pair<T,S>>	zip(Iterable<S> that)	Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
ImmutableSortedSet<Pair<T,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.

Methods inherited from class AbstractImmutableCollection

add, addAll, castToCollection, chunk, clear, countBy, countByEach, countByWith, groupByUniqueKey, parallelStream, reduce, remove, removeAll, removeAllFrom, retainAll, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong, toArray, toArray

Methods inherited from class AbstractRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, asLazy, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectOptional, detectWith, detectWithIfNone, detectWithOptional, flatCollect, forEach, forEachWith, forEachWithIndex, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Comparable

compareTo

Methods inherited from interface ImmutableCollection

aggregateBy, aggregateInPlaceBy, castToCollection, countBy, countByEach, countByWith, flatCollectWith, groupByUniqueKey, parallelStream, reduceBy, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from interface ImmutableSortedSet

collectWithIndex, drop, flatCollectWith, take, toImmutableSortedSet

Methods inherited from interface InternalIterable

forEach, forEachWith

Methods inherited from interface OrderedIterable

collectWithIndex, forEach, forEachWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, indexOf, rejectWithIndex, selectWithIndex, zip, zipWithIndex

Methods inherited from interface ReversibleIterable

asReversed, reverseForEach, reverseForEachWithIndex

Methods inherited from interface RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString

Methods inherited from interface Set

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

Methods inherited from interface SetIterable

equals, hashCode

Methods inherited from interface SortedIterable

max, min

Methods inherited from interface SortedSet

addFirst, addLast, comparator, first, last, removeFirst, removeLast, reversed, spliterator

Methods inherited from interface SortedSetIterable

comparator

Constructor Details

AbstractImmutableSortedSet

AbstractImmutableSortedSet()

Method Details

castToSortedSet

public SortedSet<T> castToSortedSet()

Specified by:

castToSortedSet in interface ImmutableSortedSet<T>

newWith

public ImmutableSortedSet<T> newWith(T element)

Description copied from interface: ImmutableCollection

This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.

Specified by:

newWith in interface ImmutableCollection<T>

Specified by:

newWith in interface ImmutableSortedSet<T>

newWithout

public ImmutableSortedSet<T> newWithout(T element)

Description copied from interface: ImmutableCollection

This method is similar to the without method in MutableCollection with the difference that a new copy of this collection with the element removed will be returned.

Specified by:

newWithout in interface ImmutableCollection<T>

Specified by:

newWithout in interface ImmutableSortedSet<T>

newWithAll

public ImmutableSortedSet<T> newWithAll(Iterable<? extends T> elements)

Description copied from interface: ImmutableCollection

This method is similar to the withAll method in MutableCollection with the difference that a new copy of this collection with the elements appended will be returned.

Specified by:

newWithAll in interface ImmutableCollection<T>

Specified by:

newWithAll in interface ImmutableSortedSet<T>

newWithoutAll

public ImmutableSortedSet<T> newWithoutAll(Iterable<? extends T> elements)

Description copied from interface: ImmutableCollection

This method is similar to the withoutAll method in MutableCollection with the difference that a new copy of this collection with the elements removed will be returned.

Specified by:

newWithoutAll in interface ImmutableCollection<T>

Specified by:

newWithoutAll in interface ImmutableSortedSet<T>

getFirst

public T getFirst()

Description copied from interface: 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 OrderedIterable<T>

Specified by:

getFirst in interface RichIterable<T>

Specified by:

getFirst in interface SequencedCollection<T>

Specified by:

getFirst in interface SortedSet<T>

getLast

public T getLast()

Description copied from interface: 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 OrderedIterable<T>

Specified by:

getLast in interface RichIterable<T>

Specified by:

getLast in interface SequencedCollection<T>

Specified by:

getLast in interface SortedSet<T>

newMutable

protected MutableCollection<T> newMutable(int size)

Specified by:

newMutable in class AbstractImmutableCollection<T>

collectBoolean

public ImmutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

BooleanIterable licenses =
    people.collectBoolean(person -> person.hasDrivingLicense());

Specified by:

collectBoolean in interface ImmutableCollection<T>

Specified by:

collectBoolean in interface ImmutableSortedSet<T>

Specified by:

collectBoolean in interface OrderedIterable<T>

Specified by:

collectBoolean in interface ReversibleIterable<T>

Specified by:

collectBoolean in interface RichIterable<T>

Specified by:

collectBoolean in interface SortedSetIterable<T>

collectByte

public ImmutableByteList collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

ByteIterable bytes =
    people.collectByte(person -> person.getCode());

Specified by:

collectByte in interface ImmutableCollection<T>

Specified by:

collectByte in interface ImmutableSortedSet<T>

Specified by:

collectByte in interface OrderedIterable<T>

Specified by:

collectByte in interface ReversibleIterable<T>

Specified by:

collectByte in interface RichIterable<T>

Specified by:

collectByte in interface SortedSetIterable<T>

collectChar

public ImmutableCharList collectChar(CharFunction<? super T> charFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

CharIterable chars =
    people.collectChar(person -> person.getMiddleInitial());

Specified by:

collectChar in interface ImmutableCollection<T>

Specified by:

collectChar in interface ImmutableSortedSet<T>

Specified by:

collectChar in interface OrderedIterable<T>

Specified by:

collectChar in interface ReversibleIterable<T>

Specified by:

collectChar in interface RichIterable<T>

Specified by:

collectChar in interface SortedSetIterable<T>

collectDouble

public ImmutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

DoubleIterable doubles =
    people.collectDouble(person -> person.getMilesFromNorthPole());

Specified by:

collectDouble in interface ImmutableCollection<T>

Specified by:

collectDouble in interface ImmutableSortedSet<T>

Specified by:

collectDouble in interface OrderedIterable<T>

Specified by:

collectDouble in interface ReversibleIterable<T>

Specified by:

collectDouble in interface RichIterable<T>

Specified by:

collectDouble in interface SortedSetIterable<T>

collectFloat

public ImmutableFloatList collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

FloatIterable floats =
    people.collectFloat(person -> person.getHeightInInches());

Specified by:

collectFloat in interface ImmutableCollection<T>

Specified by:

collectFloat in interface ImmutableSortedSet<T>

Specified by:

collectFloat in interface OrderedIterable<T>

Specified by:

collectFloat in interface ReversibleIterable<T>

Specified by:

collectFloat in interface RichIterable<T>

Specified by:

collectFloat in interface SortedSetIterable<T>

collectInt

public ImmutableIntList collectInt(IntFunction<? super T> intFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

IntIterable ints =
    people.collectInt(person -> person.getAge());

Specified by:

collectInt in interface ImmutableCollection<T>

Specified by:

collectInt in interface ImmutableSortedSet<T>

Specified by:

collectInt in interface OrderedIterable<T>

Specified by:

collectInt in interface ReversibleIterable<T>

Specified by:

collectInt in interface RichIterable<T>

Specified by:

collectInt in interface SortedSetIterable<T>

collectLong

public ImmutableLongList collectLong(LongFunction<? super T> longFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

LongIterable longs =
    people.collectLong(person -> person.getGuid());

Specified by:

collectLong in interface ImmutableCollection<T>

Specified by:

collectLong in interface ImmutableSortedSet<T>

Specified by:

collectLong in interface OrderedIterable<T>

Specified by:

collectLong in interface ReversibleIterable<T>

Specified by:

collectLong in interface RichIterable<T>

Specified by:

collectLong in interface SortedSetIterable<T>

collectShort

public ImmutableShortList collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

ShortIterable shorts =
    people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());

Specified by:

collectShort in interface ImmutableCollection<T>

Specified by:

collectShort in interface ImmutableSortedSet<T>

Specified by:

collectShort in interface OrderedIterable<T>

Specified by:

collectShort in interface ReversibleIterable<T>

Specified by:

collectShort in interface RichIterable<T>

Specified by:

collectShort in interface SortedSetIterable<T>

tap

public ImmutableSortedSet<T> tap(Procedure<? super T> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

RichIterable<Person> tapped =
    people.tap(person -> LOGGER.info(person.getName()));

Specified by:

tap in interface ImmutableCollection<T>

Specified by:

tap in interface ImmutableSetIterable<T>

Specified by:

tap in interface ImmutableSortedSet<T>

Specified by:

tap in interface OrderedIterable<T>

Specified by:

tap in interface ReversibleIterable<T>

Specified by:

tap in interface RichIterable<T>

Specified by:

tap in interface SetIterable<T>

Specified by:

tap in interface SortedIterable<T>

Specified by:

tap in interface SortedSetIterable<T>

See Also:

• RichIterable.each(Procedure)
• RichIterable.forEach(Procedure)

corresponds

public <S> boolean corresponds(OrderedIterable<S> other,
 Predicate2<? super T, ? super S> predicate)

Description copied from interface: OrderedIterable

Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.

Specified by:

corresponds in interface OrderedIterable<T>

select

public ImmutableSortedSet<T> select(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

RichIterable<Person> selected =
    people.select(person -> person.getAddress().getCity().equals("London"));

Specified by:

select in interface ImmutableCollection<T>

Specified by:

select in interface ImmutableSetIterable<T>

Specified by:

select in interface ImmutableSortedSet<T>

Specified by:

select in interface OrderedIterable<T>

Specified by:

select in interface ReversibleIterable<T>

Specified by:

select in interface RichIterable<T>

Specified by:

select in interface SetIterable<T>

Specified by:

select in interface SortedIterable<T>

Specified by:

select in interface SortedSetIterable<T>

selectWith

public <P> ImmutableSortedSet<T> selectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

RichIterable<Person> selected =
    people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));

Specified by:

selectWith in interface ImmutableCollection<T>

Specified by:

selectWith in interface ImmutableSetIterable<T>

Specified by:

selectWith in interface ImmutableSortedSet<T>

Specified by:

selectWith in interface OrderedIterable<T>

Specified by:

selectWith in interface ReversibleIterable<T>

Specified by:

selectWith in interface RichIterable<T>

Specified by:

selectWith in interface SetIterable<T>

Specified by:

selectWith in interface SortedIterable<T>

Specified by:

selectWith in interface SortedSetIterable<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 ImmutableSortedSet<T> reject(Predicate<? super T> predicate)

Description copied from interface: 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)).

Example using a Java 8 lambda expression:

RichIterable<Person> rejected =
    people.reject(person -> person.person.getLastName().equals("Smith"));

Specified by:

reject in interface ImmutableCollection<T>

Specified by:

reject in interface ImmutableSetIterable<T>

Specified by:

reject in interface ImmutableSortedSet<T>

Specified by:

reject in interface OrderedIterable<T>

Specified by:

reject in interface ReversibleIterable<T>

Specified by:

reject in interface RichIterable<T>

Specified by:

reject in interface SetIterable<T>

Specified by:

reject in interface SortedIterable<T>

Specified by:

reject in interface SortedSetIterable<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> ImmutableSortedSet<T> rejectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

RichIterable<Person> rejected =
    people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));

Specified by:

rejectWith in interface ImmutableCollection<T>

Specified by:

rejectWith in interface ImmutableSetIterable<T>

Specified by:

rejectWith in interface ImmutableSortedSet<T>

Specified by:

rejectWith in interface OrderedIterable<T>

Specified by:

rejectWith in interface ReversibleIterable<T>

Specified by:

rejectWith in interface RichIterable<T>

Specified by:

rejectWith in interface SetIterable<T>

Specified by:

rejectWith in interface SortedIterable<T>

Specified by:

rejectWith in interface SortedSetIterable<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 PartitionImmutableSortedSet<T> partition(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

PartitionIterable<Person> newYorkersAndNonNewYorkers =
    people.partition(person -> person.getAddress().getState().getName().equals("New York"));

Specified by:

partition in interface ImmutableCollection<T>

Specified by:

partition in interface ImmutableSetIterable<T>

Specified by:

partition in interface ImmutableSortedSet<T>

Specified by:

partition in interface OrderedIterable<T>

Specified by:

partition in interface ReversibleIterable<T>

Specified by:

partition in interface RichIterable<T>

Specified by:

partition in interface SetIterable<T>

Specified by:

partition in interface SortedIterable<T>

Specified by:

partition in interface SortedSetIterable<T>

partitionWith

public <P> PartitionImmutableSortedSet<T> partitionWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

PartitionIterable<Person> newYorkersAndNonNewYorkers =
    people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");

Specified by:

partitionWith in interface ImmutableCollection<T>

Specified by:

partitionWith in interface ImmutableSetIterable<T>

Specified by:

partitionWith in interface ImmutableSortedSet<T>

Specified by:

partitionWith in interface OrderedIterable<T>

Specified by:

partitionWith in interface ReversibleIterable<T>

Specified by:

partitionWith in interface RichIterable<T>

Specified by:

partitionWith in interface SetIterable<T>

Specified by:

partitionWith in interface SortedSetIterable<T>

partitionWhile

public PartitionImmutableSortedSet<T> partitionWhile(Predicate<? super T> predicate)

Description copied from interface: SortedIterable

Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.

Specified by:

partitionWhile in interface ImmutableSortedSet<T>

Specified by:

partitionWhile in interface OrderedIterable<T>

Specified by:

partitionWhile in interface ReversibleIterable<T>

Specified by:

partitionWhile in interface SortedIterable<T>

Specified by:

partitionWhile in interface SortedSetIterable<T>

selectInstancesOf

public <S> ImmutableSortedSet<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

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

RichIterable<Integer> integers =
    List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);

Specified by:

selectInstancesOf in interface ImmutableCollection<T>

Specified by:

selectInstancesOf in interface ImmutableSetIterable<T>

Specified by:

selectInstancesOf in interface ImmutableSortedSet<T>

Specified by:

selectInstancesOf in interface OrderedIterable<T>

Specified by:

selectInstancesOf in interface ReversibleIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Specified by:

selectInstancesOf in interface SetIterable<T>

Specified by:

selectInstancesOf in interface SortedIterable<T>

Specified by:

selectInstancesOf in interface SortedSetIterable<T>

collect

public <V> ImmutableList<V> collect(Function<? super T, ? extends V> function)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

RichIterable<String> names =
    people.collect(person -> person.getFirstName() + " " + person.getLastName());

Specified by:

collect in interface ImmutableCollection<T>

Specified by:

collect in interface ImmutableSortedSet<T>

Specified by:

collect in interface OrderedIterable<T>

Specified by:

collect in interface ReversibleIterable<T>

Specified by:

collect in interface RichIterable<T>

Specified by:

collect in interface SortedSetIterable<T>

collectWith

public <P,V> ImmutableList<V> collectWith(Function2<? super T, ? super P, ? extends V> function,
 P parameter)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

RichIterable<Integer> integers =
    Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));

Specified by:

collectWith in interface ImmutableCollection<T>

Specified by:

collectWith in interface ImmutableSortedSet<T>

Specified by:

collectWith in interface OrderedIterable<T>

Specified by:

collectWith in interface ReversibleIterable<T>

Specified by:

collectWith in interface RichIterable<T>

Specified by:

collectWith in interface SortedSetIterable<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> ImmutableList<V> collectIf(Predicate<? super T> predicate,
 Function<? super T, ? extends V> function)

Description copied from interface: 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 optimized equivalent of calling iterable.select(predicate).collect(function).

Example using a Java 8 lambda and method reference:

RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);

Example using Predicates factory:

RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());

Specified by:

collectIf in interface ImmutableCollection<T>

Specified by:

collectIf in interface ImmutableSortedSet<T>

Specified by:

collectIf in interface OrderedIterable<T>

Specified by:

collectIf in interface ReversibleIterable<T>

Specified by:

collectIf in interface RichIterable<T>

Specified by:

collectIf in interface SortedSetIterable<T>

flatCollect

public <V> ImmutableList<V> flatCollect(Function<? super T, ? extends Iterable<V>> function)

Description copied from interface: 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 = Person::getAddresses;
RichIterable<Person> people = ...;

Using collect returns a collection of collections of addresses.

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

Using flatCollect returns a single flattened list of addresses.

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

Specified by:

flatCollect in interface ImmutableCollection<T>

Specified by:

flatCollect in interface ImmutableSortedSet<T>

Specified by:

flatCollect in interface OrderedIterable<T>

Specified by:

flatCollect in interface ReversibleIterable<T>

Specified by:

flatCollect in interface RichIterable<T>

Specified by:

flatCollect in interface SortedSetIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

detectIndex

public int detectIndex(Predicate<? super T> predicate)

Description copied from interface: OrderedIterable

Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectIndex in interface OrderedIterable<T>

groupBy

public <V> ImmutableSortedSetMultimap<V,T> groupBy(Function<? super T, ? extends V> function)

Description copied from interface: 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.

Example using a Java 8 method reference:

Multimap<String, Person> peopleByLastName =
    people.groupBy(Person::getLastName);

Specified by:

groupBy in interface ImmutableCollection<T>

Specified by:

groupBy in interface ImmutableSetIterable<T>

Specified by:

groupBy in interface ImmutableSortedSet<T>

Specified by:

groupBy in interface OrderedIterable<T>

Specified by:

groupBy in interface ReversibleIterable<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface SortedIterable<T>

Specified by:

groupBy in interface SortedSetIterable<T>

groupByEach

public <V> ImmutableSortedSetMultimap<V,T> groupByEach(Function<? super T, ? extends Iterable<V>> function)

Description copied from interface: 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 ImmutableCollection<T>

Specified by:

groupByEach in interface ImmutableSetIterable<T>

Specified by:

groupByEach in interface ImmutableSortedSet<T>

Specified by:

groupByEach in interface OrderedIterable<T>

Specified by:

groupByEach in interface ReversibleIterable<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface SortedIterable<T>

Specified by:

groupByEach in interface SortedSetIterable<T>

zip

public <S> ImmutableList<Pair<T,S>> zip(Iterable<S> that)

Description copied from interface: 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 ImmutableCollection<T>

Specified by:

zip in interface ImmutableSortedSet<T>

Specified by:

zip in interface OrderedIterable<T>

Specified by:

zip in interface ReversibleIterable<T>

Specified by:

zip in interface RichIterable<T>

Specified by:

zip in interface SortedIterable<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 ImmutableSortedSet<Pair<T,Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface ImmutableCollection<T>

Specified by:

zipWithIndex in interface ImmutableSetIterable<T>

Specified by:

zipWithIndex in interface ImmutableSortedSet<T>

Specified by:

zipWithIndex in interface OrderedIterable<T>

Specified by:

zipWithIndex in interface ReversibleIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Specified by:

zipWithIndex in interface SetIterable<T>

Specified by:

zipWithIndex in interface SortedIterable<T>

Specified by:

zipWithIndex in interface SortedSetIterable<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)

distinct

public ImmutableSortedSet<T> distinct()

Description copied from interface: SortedIterable

Returns a new SortedIterable containing the distinct elements in this iterable.

Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears multiple times in this iterable, the first one will be copied into the result.

Specified by:

distinct in interface ImmutableSortedSet<T>

Specified by:

distinct in interface OrderedIterable<T>

Specified by:

distinct in interface ReversibleIterable<T>

Specified by:

distinct in interface SortedIterable<T>

Specified by:

distinct in interface SortedSetIterable<T>

Returns:

SortedIterable of distinct elements

takeWhile

public ImmutableSortedSet<T> takeWhile(Predicate<? super T> predicate)

Description copied from interface: SortedIterable

Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.

Specified by:

takeWhile in interface ImmutableSortedSet<T>

Specified by:

takeWhile in interface OrderedIterable<T>

Specified by:

takeWhile in interface ReversibleIterable<T>

Specified by:

takeWhile in interface SortedIterable<T>

Specified by:

takeWhile in interface SortedSetIterable<T>

dropWhile

public ImmutableSortedSet<T> dropWhile(Predicate<? super T> predicate)

Description copied from interface: SortedIterable

Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.

Specified by:

dropWhile in interface ImmutableSortedSet<T>

Specified by:

dropWhile in interface OrderedIterable<T>

Specified by:

dropWhile in interface ReversibleIterable<T>

Specified by:

dropWhile in interface SortedIterable<T>

Specified by:

dropWhile in interface SortedSetIterable<T>

toStack

public MutableStack<T> toStack()

Description copied from interface: OrderedIterable

Converts the OrderedIterable to a mutable MutableStack implementation.

Specified by:

toStack in interface OrderedIterable<T>

union

public ImmutableSortedSet<T> union(SetIterable<? extends T> set)

Description copied from interface: SortedSetIterable

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 ImmutableSortedSet<T>

Specified by:

union in interface SetIterable<T>

Specified by:

union in interface SortedSetIterable<T>

unionInto

public <R extends Set<T>> R unionInto(SetIterable<? extends T> set,
 R targetSet)

Description copied from interface: SetIterable

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

Specified by:

unionInto in interface SetIterable<T>

intersect

public ImmutableSortedSet<T> intersect(SetIterable<? extends T> set)

Description copied from interface: SortedSetIterable

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 the smaller of the two sets (this or set) based on the size. If the sizes are equal, the output will contain instances from this.

Note: If you need to ensure that the memory references from this are preserved in the resulting set, consider using this.select(that::contains) instead.

Specified by:

intersect in interface ImmutableSortedSet<T>

Specified by:

intersect in interface SetIterable<T>

Specified by:

intersect in interface SortedSetIterable<T>

intersectInto

public <R extends Set<T>> R intersectInto(SetIterable<? extends T> set,
 R targetSet)

Description copied from interface: SetIterable

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

Specified by:

intersectInto in interface SetIterable<T>

difference

public ImmutableSortedSet<T> difference(SetIterable<? extends T> subtrahendSet)

Description copied from interface: SortedSetIterable

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 ImmutableSortedSet<T>

Specified by:

difference in interface SetIterable<T>

Specified by:

difference in interface SortedSetIterable<T>

differenceInto

public <R extends Set<T>> R differenceInto(SetIterable<? extends T> subtrahendSet,
 R targetSet)

Description copied from interface: SetIterable

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

Specified by:

differenceInto in interface SetIterable<T>

symmetricDifference

public ImmutableSortedSet<T> symmetricDifference(SetIterable<? extends T> setB)

Description copied from interface: SortedSetIterable

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 ImmutableSortedSet<T>

Specified by:

symmetricDifference in interface SetIterable<T>

Specified by:

symmetricDifference in interface SortedSetIterable<T>

symmetricDifferenceInto

public <R extends Set<T>> R symmetricDifferenceInto(SetIterable<? extends T> set,
 R targetSet)

Description copied from interface: SetIterable

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

Specified by:

symmetricDifferenceInto in interface SetIterable<T>

isSubsetOf

public boolean isSubsetOf(SetIterable<? extends T> candidateSuperset)

Description copied from interface: 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 SetIterable<T>

isProperSubsetOf

public boolean isProperSubsetOf(SetIterable<? extends T> candidateSuperset)

Description copied from interface: 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 SetIterable<T>

powerSet

public ImmutableSortedSet<SortedSetIterable<T>> powerSet()

Description copied from interface: SortedSetIterable

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 ImmutableSortedSet<T>

Specified by:

powerSet in interface SortedSetIterable<T>

cartesianProduct

public <B> LazyIterable<Pair<T,B>> cartesianProduct(SetIterable<B> set)

Description copied from interface: 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 SetIterable<T>

subSet

public SortedSet<T> subSet(T fromElement,
 T toElement)

Specified by:

subSet in interface SortedSet<T>

headSet

public SortedSet<T> headSet(T toElement)

Specified by:

headSet in interface SortedSet<T>

tailSet

public SortedSet<T> tailSet(T fromElement)

Specified by:

tailSet in interface SortedSet<T>

toImmutable

public ImmutableSortedSet<T> toImmutable()

Description copied from interface: SortedSetIterable

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

Specified by:

toImmutable in interface SetIterable<T>

Specified by:

toImmutable in interface SortedSetIterable<T>

asParallel

public ParallelSortedSetIterable<T> asParallel(ExecutorService executorService,
 int batchSize)

Description copied from interface: SortedSetIterable

Returns a parallel iterable of this SortedSetIterable.

Specified by:

asParallel in interface SetIterable<T>

Specified by:

asParallel in interface SortedSetIterable<T>

toReversed

public ImmutableSortedSet<T> toReversed()

Description copied from interface: ReversibleIterable

Returns a new ReversibleIterable in reverse order.

Specified by:

toReversed in interface ImmutableSortedSet<T>

Specified by:

toReversed in interface ReversibleIterable<T>

Specified by:

toReversed in interface SortedSetIterable<T>

detectLastIndex

public int detectLastIndex(Predicate<? super T> predicate)

Description copied from interface: ReversibleIterable

Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectLastIndex in interface ReversibleIterable<T>