Package org.eclipse.collections.impl.set.sorted.mutable

Class TreeSortedSet<T>

java.lang.Object

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

org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection<T>

org.eclipse.collections.impl.set.sorted.mutable.TreeSortedSet<T>

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Comparable<SortedSetIterable<T>>, Iterable<T>, Collection<T>, Set<T>, SortedSet<T>, MutableCollection<T>, InternalIterable<T>, OrderedIterable<T>, ReversibleIterable<T>, SortedIterable<T>, RichIterable<T>, MutableSetIterable<T>, SetIterable<T>, MutableSortedSet<T>, SortedSetIterable<T>

public class TreeSortedSet<T>
extends AbstractMutableCollection<T>
implements Externalizable, MutableSortedSet<T>

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TreeSortedSet()
TreeSortedSet(Iterable<? extends T> iterable)
TreeSortedSet(Comparator<? super T> comparator)
TreeSortedSet(Comparator<? super T> comparator, Iterable<? extends T> iterable)
TreeSortedSet(SortedSet<T> set)

Method Summary

Modifier and Type	Method	Description
boolean	add(T element)
boolean	addAll(Collection<? extends T> collection)
ParallelSortedSetIterable<T>	asParallel(ExecutorService executorService, int batchSize)	Returns a parallel iterable of this SetIterable.
LazyIterable<T>	asReversed()	Returns a reversed view of this ReversibleIterable.
MutableSortedSet<T>	asSynchronized()	Returns a synchronized wrapper backed by this collection.
MutableSortedSet<T>	asUnmodifiable()	Returns an unmodifiable view of the set.
<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.
void	clear()
TreeSortedSet<T>	clone()
<V> MutableList<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.
MutableBooleanList	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.
MutableByteList	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.
MutableCharList	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.
MutableDoubleList	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.
MutableFloatList	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> MutableList<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.
MutableIntList	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.
MutableLongList	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.
MutableShortList	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> MutableList<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.
Comparator<? super T>	comparator()	Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.
int	compareTo(SortedSetIterable<T> otherSet)
boolean	contains(Object o)	Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(Collection<?> collection)	Returns true if all elements in source are contained in this collection.
<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.
TreeSortedSet<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.
MutableSortedSet<T>	distinct()	Returns a new SortedIterable containing the distinct elements in this iterable.
MutableSortedSet<T>	drop(int count)	Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
MutableSortedSet<T>	dropWhile(Predicate<? super T> predicate)	Returns the final elements that do not satisfy the Predicate.
void	each(Procedure<? super T> procedure)	The procedure is executed for each element in the iterable.
boolean	equals(Object object)	Follows the same general contract as Set.equals(Object).
T	first()
<V> MutableList<V>	flatCollect(Function<? super T,? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
void	forEach(int fromIndex, int toIndex, Procedure<? super T> procedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
T	getFirst()	Returns the first element of an iterable.
T	getLast()	Returns the last element of an iterable.
<V> TreeSortedSetMultimap<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> TreeSortedSetMultimap<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.
int	hashCode()	Follows the same general contract as Set.hashCode().
MutableSortedSet<T>	headSet(T toElement)
int	indexOf(Object object)	Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
TreeSortedSet<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.
Iterator<T>	iterator()
T	last()
TreeSortedSet<T>	newEmpty()	Creates a new empty mutable version of the same collection type.
static <T> TreeSortedSet<T>	newSet()
static <T> TreeSortedSet<T>	newSet(Iterable<? extends T> source)
static <T> TreeSortedSet<T>	newSet(Comparator<? super T> comparator)
static <T> TreeSortedSet<T>	newSet(Comparator<? super T> comparator, Iterable<? extends T> iterable)
static <T> TreeSortedSet<T>	newSetWith(Comparator<? super T> comparator, T... elements)
static <T> TreeSortedSet<T>	newSetWith(T... elements)
PartitionMutableSortedSet<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
PartitionMutableSortedSet<T>	partitionWhile(Predicate<? super T> predicate)	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> PartitionMutableSortedSet<T>	partitionWith(Predicate2<? super T,? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
MutableSortedSet<SortedSetIterable<T>>	powerSet()	Returns the set whose members are all possible subsets of this.
void	readExternal(ObjectInput in)
TreeSortedSet<T>	reject(Predicate<? super T> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<P> TreeSortedSet<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.
boolean	remove(Object element)
boolean	removeAllIterable(Iterable<?> iterable)
void	reverseForEach(Procedure<? super T> procedure)	Evaluates the procedure for each element of the list iterating in reverse order.
void	reverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)	Evaluates the procedure for each element and it's index in reverse order.
TreeSortedSet<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<S> TreeSortedSet<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> TreeSortedSet<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.
int	size()	Returns the number of items in this iterable.
MutableSortedSet<T>	subSet(T fromElement, T toElement)
MutableSortedSet<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.
MutableSortedSet<T>	tailSet(T fromElement)
MutableSortedSet<T>	take(int count)	Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
MutableSortedSet<T>	takeWhile(Predicate<? super T> predicate)	Returns the initial elements that satisfy the Predicate.
TreeSortedSet<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
ImmutableSortedSet<T>	toImmutable()	Returns an immutable copy of this set.
MutableSortedSet<T>	toReversed()	Returns a new ReversibleIterable in reverse order.
TreeSortedSet<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.
TreeSortedSet<T>	with(T element)	This method allows mutable and fixed size collections the ability to add elements to their existing elements.
TreeSortedSet<T>	with(T... elements)
TreeSortedSet<T>	with(T element1, T element2)
TreeSortedSet<T>	with(T element1, T element2, T element3)
TreeSortedSet<T>	withAll(Iterable<? extends T> elements)	This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
TreeSortedSet<T>	without(T element)	This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
TreeSortedSet<T>	withoutAll(Iterable<? extends T> elements)	This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
void	writeExternal(ObjectOutput out)
<S> MutableList<Pair<T,S>>	zip(Iterable<S> that)	Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
TreeSortedSet<Pair<T,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.

Methods inherited from class org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection

addAllIterable, chunk, countBy, countByEach, countByWith, groupByUniqueKey, injectIntoWith, reduce, removeAll, removeIf, removeIfWith, retainAll, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, asLazy, collect, collectIf, collectWith, 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, toArray, toArray, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach, forEachWith

Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection

addAllIterable, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, groupByUniqueKey, injectIntoWith, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from interface org.eclipse.collections.api.set.sorted.MutableSortedSet

collectWithIndex, flatCollectWith, toImmutableSortedSet

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

collectWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, rejectWithIndex, selectWithIndex, toStack, zip, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, 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, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, 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 java.util.Set

isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface org.eclipse.collections.api.ordered.SortedIterable

max, min

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Details

TreeSortedSet

public TreeSortedSet()

TreeSortedSet

public TreeSortedSet(Iterable<? extends T> iterable)

TreeSortedSet

public TreeSortedSet(Comparator<? super T> comparator)

TreeSortedSet

public TreeSortedSet(SortedSet<T> set)

TreeSortedSet

public TreeSortedSet(Comparator<? super T> comparator,
 Iterable<? extends T> iterable)

Method Details

newSet

public static <T> TreeSortedSet<T> newSet()

newSet

public static <T> TreeSortedSet<T> newSet(Comparator<? super T> comparator)

newSet

public static <T> TreeSortedSet<T> newSet(Iterable<? extends T> source)

newSet

public static <T> TreeSortedSet<T> newSet(Comparator<? super T> comparator,
 Iterable<? extends T> iterable)

newSetWith

public static <T> TreeSortedSet<T> newSetWith(T... elements)

newSetWith

public static <T> TreeSortedSet<T> newSetWith(Comparator<? super T> comparator,
 T... elements)

asUnmodifiable

public MutableSortedSet<T> asUnmodifiable()

Description copied from interface: MutableSortedSet

Returns an unmodifiable view of the set.

Specified by:

asUnmodifiable in interface MutableCollection<T>

Specified by:

asUnmodifiable in interface MutableSortedSet<T>

Returns:

an unmodifiable view of this set

See Also:

• Collections.unmodifiableCollection(Collection)

asSynchronized

public MutableSortedSet<T> asSynchronized()

Description copied from interface: MutableCollection

Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally.

  MutableCollection synchedCollection = collection.asSynchronized();
     ...
  synchedCollection.forEach(each -> ... );
  synchedCollection.select(each -> ... );
  synchedCollection.collect(each -> ... );
 

If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

Specified by:

asSynchronized in interface MutableCollection<T>

Specified by:

asSynchronized in interface MutableSortedSet<T>

Returns:

a synchronized view of this collection.

See Also:

• Collections.synchronizedCollection(Collection)

asParallel

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

Description copied from interface: SetIterable

Returns a parallel iterable of this SetIterable.

Specified by:

asParallel in interface SetIterable<T>

Specified by:

asParallel in interface SortedSetIterable<T>

toImmutable

public ImmutableSortedSet<T> toImmutable()

Description copied from interface: MutableSortedSet

Returns an immutable copy of this set. If the set is immutable, it returns itself.

Specified by:

toImmutable in interface MutableCollection<T>

Specified by:

toImmutable in interface MutableSortedSet<T>

Specified by:

toImmutable in interface SetIterable<T>

Specified by:

toImmutable in interface SortedSetIterable<T>

add

public boolean add(T element)

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

Overrides:

add in class AbstractMutableCollection<T>

remove

public boolean remove(Object element)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

Overrides:

remove in class AbstractMutableCollection<T>

addAll

public boolean addAll(Collection<? extends T> collection)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

Overrides:

addAll in class AbstractMutableCollection<T>

contains

public boolean contains(Object o)

Description copied from interface: RichIterable

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

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface RichIterable<T>

Specified by:

contains in interface Set<T>

Overrides:

contains in class AbstractRichIterable<T>

containsAll

public boolean containsAll(Collection<?> collection)

Description copied from interface: RichIterable

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

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface RichIterable<T>

Specified by:

containsAll in interface Set<T>

Overrides:

containsAll in class AbstractRichIterable<T>

See Also:

• Collection.containsAll(Collection)

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>

clone

public TreeSortedSet<T> clone()

Specified by:

clone in interface MutableSortedSet<T>

equals

public boolean equals(Object object)

Description copied from interface: SetIterable

Follows the same general contract as Set.equals(Object).

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Specified by:

equals in interface SetIterable<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: SetIterable

Follows the same general contract as Set.hashCode().

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Specified by:

hashCode in interface SetIterable<T>

Overrides:

hashCode in class Object

with

public TreeSortedSet<T> with(T element)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.with("1");
 list = list.with("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.

Specified by:

with in interface MutableCollection<T>

Specified by:

with in interface MutableSetIterable<T>

Specified by:

with in interface MutableSortedSet<T>

See Also:

• Collection.add(Object)

with

public TreeSortedSet<T> with(T element1,
 T element2)

with

public TreeSortedSet<T> with(T element1,
 T element2,
 T element3)

with

public TreeSortedSet<T> with(T... elements)

without

public TreeSortedSet<T> without(T element)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.without("1");
 list = list.without("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.

Specified by:

without in interface MutableCollection<T>

Specified by:

without in interface MutableSetIterable<T>

Specified by:

without in interface MutableSortedSet<T>

See Also:

• Collection.remove(Object)

withAll

public TreeSortedSet<T> withAll(Iterable<? extends T> elements)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.

Specified by:

withAll in interface MutableCollection<T>

Specified by:

withAll in interface MutableSetIterable<T>

Specified by:

withAll in interface MutableSortedSet<T>

See Also:

• Collection.addAll(Collection)

withoutAll

public TreeSortedSet<T> withoutAll(Iterable<? extends T> elements)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.

Specified by:

withoutAll in interface MutableCollection<T>

Specified by:

withoutAll in interface MutableSetIterable<T>

Specified by:

withoutAll in interface MutableSortedSet<T>

See Also:

• Collection.removeAll(Collection)

newEmpty

public TreeSortedSet<T> newEmpty()

Description copied from interface: MutableCollection

Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.

Specified by:

newEmpty in interface MutableCollection<T>

Specified by:

newEmpty in interface MutableSortedSet<T>

tap

public TreeSortedSet<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()));
 

Example using an anonymous inner class:

 RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface MutableCollection<T>

Specified by:

tap in interface MutableSetIterable<T>

Specified by:

tap in interface MutableSortedSet<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)

each

public void each(Procedure<? super T> procedure)

Description copied from interface: RichIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

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

Specified by:

each in interface RichIterable<T>

See Also:

• InternalIterable.forEach(Procedure)
• Iterable.forEach(java.util.function.Consumer)

select

public TreeSortedSet<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"));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
 

Specified by:

select in interface MutableCollection<T>

Specified by:

select in interface MutableSetIterable<T>

Specified by:

select in interface MutableSortedSet<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>

reject

public TreeSortedSet<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"));
 

Example using an anonymous inner class:

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

Specified by:

reject in interface MutableCollection<T>

Specified by:

reject in interface MutableSetIterable<T>

Specified by:

reject in interface MutableSortedSet<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

partition

public PartitionMutableSortedSet<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"));
 

Example using an anonymous inner class:

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

Specified by:

partition in interface MutableCollection<T>

Specified by:

partition in interface MutableSetIterable<T>

Specified by:

partition in interface MutableSortedSet<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> PartitionMutableSortedSet<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");
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     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 MutableCollection<T>

Specified by:

partitionWith in interface MutableSetIterable<T>

Specified by:

partitionWith in interface MutableSortedSet<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 PartitionMutableSortedSet<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 MutableSortedSet<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> TreeSortedSet<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 MutableCollection<T>

Specified by:

selectInstancesOf in interface MutableSetIterable<T>

Specified by:

selectInstancesOf in interface MutableSortedSet<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> MutableList<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());
 

Example using an anonymous inner class:

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

Specified by:

collect in interface MutableCollection<T>

Specified by:

collect in interface MutableSortedSet<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>

collectBoolean

public MutableBooleanList 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());
 

Example using an anonymous inner class:

 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 

Specified by:

collectBoolean in interface MutableCollection<T>

Specified by:

collectBoolean in interface MutableSortedSet<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 MutableByteList 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());
 

Example using an anonymous inner class:

 ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
 

Specified by:

collectByte in interface MutableCollection<T>

Specified by:

collectByte in interface MutableSortedSet<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 MutableCharList 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());
 

Example using an anonymous inner class:

 CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
 

Specified by:

collectChar in interface MutableCollection<T>

Specified by:

collectChar in interface MutableSortedSet<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 MutableDoubleList 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());
 

Example using an anonymous inner class:

 DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
 

Specified by:

collectDouble in interface MutableCollection<T>

Specified by:

collectDouble in interface MutableSortedSet<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 MutableFloatList 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());
 

Example using an anonymous inner class:

 FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
 

Specified by:

collectFloat in interface MutableCollection<T>

Specified by:

collectFloat in interface MutableSortedSet<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 MutableIntList 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());
 

Example using an anonymous inner class:

 IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
 

Specified by:

collectInt in interface MutableCollection<T>

Specified by:

collectInt in interface MutableSortedSet<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 MutableLongList 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());
 

Example using an anonymous inner class:

 LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
 

Specified by:

collectLong in interface MutableCollection<T>

Specified by:

collectLong in interface MutableSortedSet<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 MutableShortList 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());
 

Example using an anonymous inner class:

 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 

Specified by:

collectShort in interface MutableCollection<T>

Specified by:

collectShort in interface MutableSortedSet<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>

flatCollect

public <V> MutableList<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 MutableCollection<T>

Specified by:

flatCollect in interface MutableSortedSet<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

collectIf

public <V> MutableList<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 MutableCollection<T>

Specified by:

collectIf in interface MutableSortedSet<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>

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

Example using an anonymous inner class:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     });
 

Specified by:

groupBy in interface MutableCollection<T>

Specified by:

groupBy in interface MutableSetIterable<T>

Specified by:

groupBy in interface MutableSortedSet<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> TreeSortedSetMultimap<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 MutableCollection<T>

Specified by:

groupByEach in interface MutableSetIterable<T>

Specified by:

groupByEach in interface MutableSortedSet<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>

selectWith

public <P> TreeSortedSet<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));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18));
 

Specified by:

selectWith in interface MutableCollection<T>

Specified by:

selectWith in interface MutableSetIterable<T>

Specified by:

selectWith in interface MutableSortedSet<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)

rejectWith

public <P> TreeSortedSet<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));
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 

Specified by:

rejectWith in interface MutableCollection<T>

Specified by:

rejectWith in interface MutableSetIterable<T>

Specified by:

rejectWith in interface MutableSortedSet<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)

collectWith

public <P,
V> MutableList<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));
 

Example using an anonymous inner class:

 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

collectWith in interface MutableCollection<T>

Specified by:

collectWith in interface MutableSortedSet<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)

zip

public <S> MutableList<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 MutableCollection<T>

Specified by:

zip in interface MutableSetIterable<T>

Specified by:

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

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface MutableCollection<T>

Specified by:

zipWithIndex in interface MutableSetIterable<T>

Specified by:

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

takeWhile

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

distinct

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

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>

forEach

public void forEach(int fromIndex,
 int toIndex,
 Procedure<? super T> procedure)

Description copied from interface: OrderedIterable

Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure<Person>()
 {
     public void value(Person person)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEach in interface OrderedIterable<T>

forEachWithIndex

public void forEachWithIndex(int fromIndex,
 int toIndex,
 ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: OrderedIterable

Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int index)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEachWithIndex in interface OrderedIterable<T>

removeAllIterable

public boolean removeAllIterable(Iterable<?> iterable)

Specified by:

removeAllIterable in interface MutableCollection<T>

Overrides:

removeAllIterable in class AbstractMutableCollection<T>

See Also:

• Collection.removeAll(Collection)

comparator

public Comparator<? super T> comparator()

Description copied from interface: SortedSetIterable

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

Specified by:

comparator in interface SortedIterable<T>

Specified by:

comparator in interface SortedSet<T>

Specified by:

comparator in interface SortedSetIterable<T>

subSet

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

Specified by:

subSet in interface MutableSortedSet<T>

Specified by:

subSet in interface SortedSet<T>

headSet

public MutableSortedSet<T> headSet(T toElement)

Specified by:

headSet in interface MutableSortedSet<T>

Specified by:

headSet in interface SortedSet<T>

tailSet

public MutableSortedSet<T> tailSet(T fromElement)

Specified by:

tailSet in interface MutableSortedSet<T>

Specified by:

tailSet in interface SortedSet<T>

first

public T first()

Specified by:

first in interface SortedSet<T>

last

public T last()

Specified by:

last in interface SortedSet<T>

indexOf

public int indexOf(Object object)

Description copied from interface: OrderedIterable

Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.

Specified by:

indexOf in interface OrderedIterable<T>

See Also:

• List.indexOf(Object)

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>

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>

powerSet

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

union

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

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

Specified by:

union in interface SetIterable<T>

Specified by:

union in interface SortedSetIterable<T>

intersect

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

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

Specified by:

intersect in interface SetIterable<T>

Specified by:

intersect in interface SortedSetIterable<T>

difference

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

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

Specified by:

difference in interface SetIterable<T>

Specified by:

difference in interface SortedSetIterable<T>

symmetricDifference

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

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

Specified by:

symmetricDifference in interface SetIterable<T>

Specified by:

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

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>

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>

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>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Set<T>

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface Collection<T>

Specified by:

size in interface RichIterable<T>

Specified by:

size in interface Set<T>

toReversed

public MutableSortedSet<T> toReversed()

Description copied from interface: ReversibleIterable

Returns a new ReversibleIterable in reverse order.

Specified by:

toReversed in interface MutableSortedSet<T>

Specified by:

toReversed in interface ReversibleIterable<T>

Specified by:

toReversed in interface SortedSetIterable<T>

take

public MutableSortedSet<T> take(int count)

Description copied from interface: ReversibleIterable

Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.

Specified by:

take in interface MutableSortedSet<T>

Specified by:

take in interface ReversibleIterable<T>

Specified by:

take in interface SortedSetIterable<T>

Parameters:

count - the number of items to take.

drop

public MutableSortedSet<T> drop(int count)

Description copied from interface: ReversibleIterable

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

Specified by:

drop in interface MutableSortedSet<T>

Specified by:

drop in interface ReversibleIterable<T>

Specified by:

drop in interface SortedSetIterable<T>

Parameters:

count - the number of items to drop.

reverseForEach

public void reverseForEach(Procedure<? super T> procedure)

Description copied from interface: ReversibleIterable

Evaluates the procedure for each element of the list iterating in reverse order.

e.g.
 people.reverseForEach(person -> LOGGER.info(person.getName()));
 

Specified by:

reverseForEach in interface ReversibleIterable<T>

reverseForEachWithIndex

public void reverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)

Description copied from interface: ReversibleIterable

Evaluates the procedure for each element and it's index in reverse order.

e.g.
 people.reverseForEachWithIndex((person, index) ->
         LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Specified by:

reverseForEachWithIndex in interface ReversibleIterable<T>

asReversed

public LazyIterable<T> asReversed()

Description copied from interface: ReversibleIterable

Returns a reversed view of this ReversibleIterable.

Specified by:

asReversed in interface ReversibleIterable<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>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

compareTo

public int compareTo(SortedSetIterable<T> otherSet)

Specified by:

compareTo in interface Comparable<T>