TreeSortedSet (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.AbstractRichIterable<T>
- - com.gs.collections.impl.collection.mutable.AbstractMutableCollection<T>
 - - com.gs.collections.impl.set.sorted.mutable.TreeSortedSet<T>

All Implemented Interfaces:

com.gs.collections.api.collection.MutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.ordered.SortedIterable<T>, com.gs.collections.api.RichIterable<T>, com.gs.collections.api.set.SetIterable<T>, com.gs.collections.api.set.sorted.MutableSortedSet<T>, com.gs.collections.api.set.sorted.SortedSetIterable<T>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<com.gs.collections.api.set.sorted.SortedSetIterable<T>>, java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>, java.util.SortedSet<T>
```
public final class TreeSortedSet<T>
extends AbstractMutableCollection<T>
implements java.io.Externalizable, com.gs.collections.api.set.sorted.MutableSortedSet<T>
```
See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TreeSortedSet()`
`TreeSortedSet(java.util.Comparator<? super T> comparator)`
`TreeSortedSet(java.util.Comparator<? super T> comparator, java.lang.Iterable<? extends T> iterable)`
`TreeSortedSet(java.lang.Iterable<? extends T> iterable)`
`TreeSortedSet(java.util.SortedSet<T> set)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(T element)`
`boolean`	`addAll(java.util.Collection<? extends T> collection)`
`com.gs.collections.api.set.sorted.ParallelSortedSetIterable<T>`	`asParallel(java.util.concurrent.ExecutorService executorService, int batchSize)`
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`asSynchronized()` Returns a synchronized (thread-safe) collection backed by this collection.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`asUnmodifiable()` Returns an unmodifable view of the set.
`<B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>>`	`cartesianProduct(com.gs.collections.api.set.SetIterable<B> set)` Returns the set whose members are all possible ordered pairs (a, b) where a is a member of `this` and b is a member of `set`.
`void`	`clear()`
`TreeSortedSet<T>`	`clone()`
`<V> com.gs.collections.api.list.MutableList<V>`	`collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Returns a new collection with the results of applying the specified function on each element of the source collection.
`com.gs.collections.api.list.primitive.MutableBooleanList`	`collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)` Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection.
`com.gs.collections.api.list.primitive.MutableByteList`	`collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)` Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection.
`com.gs.collections.api.list.primitive.MutableCharList`	`collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)` Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection.
`com.gs.collections.api.list.primitive.MutableDoubleList`	`collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)` Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection.
`com.gs.collections.api.list.primitive.MutableFloatList`	`collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)` Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection.
`<V> com.gs.collections.api.list.MutableList<V>`	`collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
`com.gs.collections.api.list.primitive.MutableIntList`	`collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)` Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection.
`com.gs.collections.api.list.primitive.MutableLongList`	`collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)` Returns a new primitive `long` iterable with the results of applying the specified function on each element of the source collection.
`com.gs.collections.api.list.primitive.MutableShortList`	`collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)` Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection.
`<P,V> com.gs.collections.api.list.MutableList<V>`	`collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter)` Same as collect with a `Function2` and specified parameter which is passed to the block
`java.util.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(com.gs.collections.api.set.sorted.SortedSetIterable<T> otherSet)`
`boolean`	`contains(java.lang.Object o)` Returns true if the iterable has an element which responds true to element.equals(object).
`boolean`	`containsAll(java.util.Collection<?> collection)` Returns true if all elements in source are contained in this collection.
`TreeSortedSet<T>`	`difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet)` Returns the set of all members of `this` that are not members of `subtrahendSet`.
`<R extends java.util.Set<T>> R`	`differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet, R targetSet)` Same as `SetIterable.difference(SetIterable)` but adds all the objects to `targetSet` and returns it.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`distinct()` Returns a new `SortedIterable` containing the distinct elements in this iterable.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns the final elements that do not satisfy the Predicate.
`boolean`	`equals(java.lang.Object object)` Follows the same general contract as `Set.equals(Object)`.
`T`	`first()`
`<V> com.gs.collections.api.list.MutableList<V>`	`flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`void`	`forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)` The procedure is executed for each element in the iterable.
`T`	`getFirst()` Returns the first element of an iterable.
`T`	`getLast()` Returns the last element of an iterable.
`<V> TreeSortedSetMultimap<V,T>`	`groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
`<V> TreeSortedSetMultimap<V,T>`	`groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)` Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`<V> com.gs.collections.api.map.MutableMap<V,T>`	`groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
`int`	`hashCode()` Follows the same general contract as `Set.hashCode()`.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`headSet(T toElement)`
`TreeSortedSet<T>`	`intersect(com.gs.collections.api.set.SetIterable<? extends T> set)` Returns the set of all objects that are members of both `this` and `set`.
`<R extends java.util.Set<T>> R`	`intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet)` Same as `SetIterable.intersect(SetIterable)` but adds all the objects to `targetSet` and returns it.
`boolean`	`isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)` Returns true if all the members of `this` are also members of `candidateSuperset` and the two sets are not equal.
`boolean`	`isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)` Returns true if all the members of `this` are also members of `candidateSuperset`.
`java.util.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(java.util.Comparator<? super T> comparator)`
`static <T> TreeSortedSet<T>`	`newSet(java.util.Comparator<? super T> comparator, java.lang.Iterable<? extends T> iterable)`
`static <T> TreeSortedSet<T>`	`newSet(java.lang.Iterable<? extends T> source)`
`static <T> TreeSortedSet<T>`	`newSetWith(java.util.Comparator<? super T> comparator, T... elements)`
`static <T> TreeSortedSet<T>`	`newSetWith(T... elements)`
`com.gs.collections.api.partition.set.sorted.PartitionMutableSortedSet<T>`	`partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`com.gs.collections.api.partition.set.sorted.PartitionMutableSortedSet<T>`	`partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
`<P> com.gs.collections.api.partition.set.sorted.PartitionMutableSortedSet<T>`	`partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`com.gs.collections.api.set.sorted.MutableSortedSet<com.gs.collections.api.set.sorted.SortedSetIterable<T>>`	`powerSet()` Returns the set whose members are all possible subsets of `this`.
`void`	`readExternal(java.io.ObjectInput in)`
`TreeSortedSet<T>`	`reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> TreeSortedSet<T>`	`rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Similar to `RichIterable.reject(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`boolean`	`remove(java.lang.Object element)`
`boolean`	`removeAllIterable(java.lang.Iterable<?> iterable)`
`TreeSortedSet<T>`	`select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<S> TreeSortedSet<S>`	`selectInstancesOf(java.lang.Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> TreeSortedSet<T>`	`selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Similar to `RichIterable.select(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`int`	`size()` Returns the number of items in this iterable.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`subSet(T fromElement, T toElement)`
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB)` Returns the set of all objects that are a member of exactly one of `this` and `setB` (elements which are in one of the sets, but not in both).
`<R extends java.util.Set<T>> R`	`symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet)` Same as `SetIterable.symmetricDifference(SetIterable)` but adds all the objects to `targetSet` and returns it.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`tailSet(T fromElement)`
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns the initial elements that satisfy the Predicate.
`com.gs.collections.api.set.sorted.ImmutableSortedSet<T>`	`toImmutable()` Returns an immutable copy of this set.
`com.gs.collections.api.stack.MutableStack<T>`	`toStack()` Converts the SortedIterable to a mutable MutableStack implementation.
`TreeSortedSet<T>`	`union(com.gs.collections.api.set.SetIterable<? extends T> set)` Returns the set of all objects that are a member of `this` or `set` or both.
`<R extends java.util.Set<T>> R`	`unionInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet)` Same as `SetIterable.union(SetIterable)` but adds all the objects to `targetSet` and returns it.
`TreeSortedSet<T>`	`with(T... elements)`
`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 element1, T element2)`
`TreeSortedSet<T>`	`with(T element1, T element2, T element3)`
`TreeSortedSet<T>`	`withAll(java.lang.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(java.lang.Iterable<? extends T> elements)` This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
`void`	`writeExternal(java.io.ObjectOutput out)`
`<S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>>`	`zip(java.lang.Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`TreeSortedSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from class com.gs.collections.impl.collection.mutable.AbstractMutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, chunk, injectIntoWith, removeAll, removeIf, removeIfWith, retainAll, retainAllIterable, selectAndRejectWith

Methods inherited from class com.gs.collections.impl.AbstractRichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEachWith, forEachWithIndex, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.api.ordered.SortedIterable
max, min

Methods inherited from interface com.gs.collections.api.RichIterable
aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, maxBy, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable
forEachWith, forEachWithIndex

Methods inherited from interface com.gs.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, injectIntoWith, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith

Methods inherited from interface java.util.Set
isEmpty, removeAll, retainAll, toArray, toArray

- Constructor Detail
 - TreeSortedSet
```
public TreeSortedSet()
```
 - TreeSortedSet
```
public TreeSortedSet(java.lang.Iterable<? extends T> iterable)
```
 - TreeSortedSet
```
public TreeSortedSet(java.util.Comparator<? super T> comparator)
```
 - TreeSortedSet
```
public TreeSortedSet(java.util.SortedSet<T> set)
```
 - TreeSortedSet
```
public TreeSortedSet(java.util.Comparator<? super T> comparator,
 java.lang.Iterable<? extends T> iterable)
```
- Method Detail
 - newSet
```
public static <T> TreeSortedSet<T> newSet()
```
 - newSet
```
public static <T> TreeSortedSet<T> newSet(java.util.Comparator<? super T> comparator)
```
 - newSet
```
public static <T> TreeSortedSet<T> newSet(java.lang.Iterable<? extends T> source)
```
 - newSet
```
public static <T> TreeSortedSet<T> newSet(java.util.Comparator<? super T> comparator,
 java.lang.Iterable<? extends T> iterable)
```
 - newSetWith
```
public static <T> TreeSortedSet<T> newSetWith(T... elements)
```
 - newSetWith
```
public static <T> TreeSortedSet<T> newSetWith(java.util.Comparator<? super T> comparator,
 T... elements)
```
 - asUnmodifiable
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> asUnmodifiable()
```
 Description copied from interface: com.gs.collections.api.set.sorted.MutableSortedSet
 
 Returns an unmodifable view of the set. The returned set will be Serializable if this set is Serializable.
 
 Specified by:
 
 asUnmodifiable in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 asUnmodifiable in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Returns:
 an unmodifiable view of this set
 - asSynchronized
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> asSynchronized()
```
 Description copied from interface: com.gs.collections.api.collection.MutableCollection
 Returns a synchronized (thread-safe) collection backed by this collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.
 It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.
```
 MutableCollection collection = myCollection.asSynchronized();
 ...
 synchronized(collection)
 {
 Iterator i = c.iterator(); // Must be in the synchronized block
 while (i.hasNext())
 foo(i.next());
 }
 
```
 Failure to follow this advice may result in non-deterministic behavior.
 The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.
```
 MutableCollection collection = myCollection.asSynchronized();
 ...
 collection.forEach(new Procedure()
 {
 public void value(Object each)
 {
 ...
 }
 });
 
```
 The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
 The returned collection will be serializable if this collection is serializable.
 Specified by:
 
 asSynchronized in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 asSynchronized in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Returns:
 a synchronized view of this collection.
 - asParallel
```
public com.gs.collections.api.set.sorted.ParallelSortedSetIterable<T> asParallel(java.util.concurrent.ExecutorService executorService,
 int batchSize)
```
 - toImmutable
```
public com.gs.collections.api.set.sorted.ImmutableSortedSet<T> toImmutable()
```
 Description copied from interface: com.gs.collections.api.set.sorted.MutableSortedSet
 
 Returns an immutable copy of this set. If the set is immutable, it returns itself.
 The returned set will be Serializable if this set is Serializable.
 
 Specified by:
 
 toImmutable in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 toImmutable in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 toImmutable in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - toStack
```
public com.gs.collections.api.stack.MutableStack<T> toStack()
```
 Description copied from interface: com.gs.collections.api.ordered.SortedIterable
 
 Converts the SortedIterable to a mutable MutableStack implementation.
 
 Specified by:
 
 toStack in interface com.gs.collections.api.ordered.SortedIterable<T>
 - add
```
public boolean add(T element)
```
 Specified by:
 
 add in interface java.util.Collection<T>
 
 Specified by:
 
 add in interface java.util.Set<T>
 
 Overrides:
 
 add in class AbstractMutableCollection<T>
 - remove
```
public boolean remove(java.lang.Object element)
```
 Specified by:
 
 remove in interface java.util.Collection<T>
 
 Specified by:
 
 remove in interface java.util.Set<T>
 
 Overrides:
 
 remove in class AbstractMutableCollection<T>
 - addAll
```
public boolean addAll(java.util.Collection<? extends T> collection)
```
 Specified by:
 
 addAll in interface java.util.Collection<T>
 
 Specified by:
 
 addAll in interface java.util.Set<T>
 
 Overrides:
 
 addAll in class AbstractMutableCollection<T>
 - contains
```
public boolean contains(java.lang.Object o)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the iterable has an element which responds true to element.equals(object).
 
 Specified by:
 
 contains in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 contains in interface java.util.Collection<T>
 
 Specified by:
 
 contains in interface java.util.Set<T>
 
 Overrides:
 
 contains in class AbstractRichIterable<T>
 - containsAll
```
public boolean containsAll(java.util.Collection<?> collection)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if all elements in source are contained in this collection.
 
 Specified by:
 
 containsAll in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 containsAll in interface java.util.Collection<T>
 
 Specified by:
 
 containsAll in interface java.util.Set<T>
 
 Overrides:
 
 containsAll in class AbstractRichIterable<T>
 
 See Also:
 Collection.containsAll(Collection)
 - clear
```
public void clear()
```
 Specified by:
 
 clear in interface java.util.Collection<T>
 
 Specified by:
 
 clear in interface java.util.Set<T>
 - clone
```
public TreeSortedSet<T> clone()
```
 Specified by:
 
 clone in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Overrides:
 
 clone in class java.lang.Object
 - equals
```
public boolean equals(java.lang.Object object)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Follows the same general contract as Set.equals(Object).
 
 Specified by:
 
 equals in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 equals in interface java.util.Collection<T>
 
 Specified by:
 
 equals in interface java.util.Set<T>
 
 Overrides:
 
 equals in class java.lang.Object
 - hashCode
```
public int hashCode()
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Follows the same general contract as Set.hashCode().
 
 Specified by:
 
 hashCode in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 hashCode in interface java.util.Collection<T>
 
 Specified by:
 
 hashCode in interface java.util.Set<T>
 
 Overrides:
 
 hashCode in class java.lang.Object
 - with
```
public TreeSortedSet<T> with(T element)
```
 Description copied from interface: com.gs.collections.api.collection.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 list;
 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 com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 with in interface com.gs.collections.api.set.sorted.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: com.gs.collections.api.collection.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 contaning 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 list;
 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 com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 without in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 See Also:
 Collection.remove(Object)
 - withAll
```
public TreeSortedSet<T> withAll(java.lang.Iterable<? extends T> elements)
```
 Description copied from interface: com.gs.collections.api.collection.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 list;
 list = list.withAll(FastList.newListWith("1", "2"));
 return list;
 
```
 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 com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 withAll in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 See Also:
 Collection.addAll(Collection)
 - withoutAll
```
public TreeSortedSet<T> withoutAll(java.lang.Iterable<? extends T> elements)
```
 Description copied from interface: com.gs.collections.api.collection.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 contaning 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 list;
 list = list.withoutAll(FastList.newListWith("1", "2"));
 return list;
 
```
 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 com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 withoutAll in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 See Also:
 Collection.removeAll(Collection)
 - newEmpty
```
public TreeSortedSet<T> newEmpty()
```
 Description copied from interface: com.gs.collections.api.collection.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 com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 newEmpty in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 - forEach
```
public void forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
```
 Description copied from interface: com.gs.collections.api.InternalIterable
 The procedure is executed for each element in the iterable.
```
e.g.
 people.forEach(new Procedure()
 {
 public void value(Person person)
 {
 LOGGER.info(person.getName());
 }
 });
 
```
 Specified by:
 
 forEach in interface com.gs.collections.api.InternalIterable<T>
 - select
```
public TreeSortedSet<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getCity().equals("Metuchen");
 }
 });
 
```
 Specified by:
 
 select in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - reject
```
public TreeSortedSet<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 });
 
```
```
e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 
```
 Specified by:
 
 reject in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.set.sorted.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 com.gs.collections.api.partition.set.sorted.PartitionMutableSortedSet<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
```
e.g.
 return people.partition(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getState().getName().equals("New York");
 }
 });
 
```
 Specified by:
 
 partition in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 partition in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 partition in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 partition in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 partition in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 partition in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - partitionWith
```
public  com.gs.collections.api.partition.set.sorted.PartitionMutableSortedSet<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Filters a collection into a PartitionIterable based on the evaluation of the predicate.
```
e.g.
 return people.partitionWith(new Predicate2<Person, String>()
 {
 public boolean accept(Person person, String state)
 {
 return person.getAddress().getState().getName().equals(state);
 }
 }, "New York");
 
```
 Specified by:
 
 partitionWith in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 partitionWith in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 partitionWith in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 partitionWith in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 partitionWith in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - partitionWhile
```
public com.gs.collections.api.partition.set.sorted.PartitionMutableSortedSet<T> partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 partitionWhile in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 partitionWhile in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - selectInstancesOf
```
public <S> TreeSortedSet<S> selectInstancesOf(java.lang.Class<S> clazz)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns all elements of the source collection that are instances of the Class clazz.
 
 Specified by:
 
 selectInstancesOf in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 selectInstancesOf in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 selectInstancesOf in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 selectInstancesOf in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 selectInstancesOf in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 selectInstancesOf in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collect
```
public <V> com.gs.collections.api.list.MutableList<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
 public String valueOf(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 collect in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collect in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collect in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collect in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectBoolean
```
public com.gs.collections.api.list.primitive.MutableBooleanList collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
 public boolean booleanValueOf(Person person)
 {
 return person.hasDrivingLicense();
 }
 });
 
```
 Specified by:
 
 collectBoolean in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectBoolean in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectBoolean in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectBoolean in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectByte
```
public com.gs.collections.api.list.primitive.MutableByteList collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
 public byte byteValueOf(Person person)
 {
 return person.getCode();
 }
 });
 
```
 Specified by:
 
 collectByte in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectByte in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectByte in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectByte in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectChar
```
public com.gs.collections.api.list.primitive.MutableCharList collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectChar(new CharFunction<Person>()
 {
 public char charValueOf(Person person)
 {
 return person.getMiddleInitial();
 }
 });
 
```
 Specified by:
 
 collectChar in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectChar in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectChar in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectChar in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectDouble
```
public com.gs.collections.api.list.primitive.MutableDoubleList collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
 public double doubleValueOf(Person person)
 {
 return person.getMilesFromNorthPole();
 }
 });
 
```
 Specified by:
 
 collectDouble in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectDouble in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectDouble in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectDouble in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectFloat
```
public com.gs.collections.api.list.primitive.MutableFloatList collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
 public float floatValueOf(Person person)
 {
 return person.getHeightInInches();
 }
 });
 
```
 Specified by:
 
 collectFloat in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectFloat in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectFloat in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectFloat in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectInt
```
public com.gs.collections.api.list.primitive.MutableIntList collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectInt(new IntFunction<Person>()
 {
 public int intValueOf(Person person)
 {
 return person.getAge();
 }
 });
 
```
 Specified by:
 
 collectInt in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectInt in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectInt in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectInt in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectLong
```
public com.gs.collections.api.list.primitive.MutableLongList collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectLong(new LongFunction<Person>()
 {
 public long longValueOf(Person person)
 {
 return person.getGuid();
 }
 });
 
```
 Specified by:
 
 collectLong in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectLong in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectLong in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectLong in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - collectShort
```
public com.gs.collections.api.list.primitive.MutableShortList collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
 public short shortValueOf(Person person)
 {
 return person.getNumberOfJunkMailItemsReceivedPerMonth();
 }
 });
 
```
 Specified by:
 
 collectShort in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectShort in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectShort in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectShort in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - flatCollect
```
public <V> com.gs.collections.api.list.MutableList<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.
 Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:
```
 Function<Person, List<Address>> addressFunction = new Function<Person, List<Address>>()
 {
 public List<Address> valueOf(Person person)
 {
 return person.getAddresses();
 }
 };
 MutableList<Person> people = ...;
 
```
 Using collect returns a collection of collections of addresses.
```
 MutableList<List<Address>> addresses = people.collect(addressFunction);
 
```
 Using flatCollect returns a single flattened list of addresses.
```
 MutableList<Address> addresses = people.flatCollect(addressFunction);
 
```
 Specified by:
 
 flatCollect in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 
 Parameters:
 function - The Function to apply
 
 Returns:
 a new flattened collection produced by applying the given function
 - collectIf
```
public <V> com.gs.collections.api.list.MutableList<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
 com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).
```
e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 
```
 Specified by:
 
 collectIf in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - groupBy
```
public <V> TreeSortedSetMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 groupBy in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 groupBy in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 groupBy in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 groupBy in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 groupBy in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - groupByEach
```
public <V> TreeSortedSetMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - groupByUniqueKey
```
public <V> com.gs.collections.api.map.MutableMap<V,T> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.
 
 Specified by:
 
 groupByUniqueKey in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 groupByUniqueKey in interface com.gs.collections.api.RichIterable<T>
 
 See Also:
 RichIterable.groupBy(Function)
 - selectWith
```
public  TreeSortedSet<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.set.sorted.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  TreeSortedSet<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.set.sorted.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> com.gs.collections.api.list.MutableList<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as collect with a Function2 and specified parameter which is passed to the block
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
 public Integer value(final Integer each, final Integer parameter)
 {
 return each + parameter;
 }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
 Specified by:
 
 collectWith in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 collectWith in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectWith in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 collectWith in interface com.gs.collections.api.set.sorted.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> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
 
 Specified by:
 
 zip in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 zip in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 zip in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 zip in interface com.gs.collections.api.set.sorted.MutableSortedSet<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<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Zips this RichIterable with its indices.
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.set.sorted.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 com.gs.collections.api.set.sorted.MutableSortedSet<T> takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 takeWhile in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 takeWhile in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - dropWhile
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 dropWhile in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 dropWhile in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - distinct
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> distinct()
```
 Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 distinct in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 distinct in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 
 Returns:
 SortedIterable of distinct elements
 - removeAllIterable
```
public boolean removeAllIterable(java.lang.Iterable<?> iterable)
```
 Specified by:
 
 removeAllIterable in interface com.gs.collections.api.collection.MutableCollection<T>
 
 Overrides:
 
 removeAllIterable in class AbstractMutableCollection<T>
 
 See Also:
 Collection.removeAll(Collection)
 - comparator
```
public java.util.Comparator<? super T> comparator()
```
 Description copied from interface: com.gs.collections.api.set.sorted.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 com.gs.collections.api.ordered.SortedIterable<T>
 
 Specified by:
 
 comparator in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 
 Specified by:
 
 comparator in interface java.util.SortedSet<T>
 - subSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> subSet(T fromElement,
 T toElement)
```
 Specified by:
 
 subSet in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 subSet in interface java.util.SortedSet<T>
 - headSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> headSet(T toElement)
```
 Specified by:
 
 headSet in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 headSet in interface java.util.SortedSet<T>
 - tailSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> tailSet(T fromElement)
```
 Specified by:
 
 tailSet in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 tailSet in interface java.util.SortedSet<T>
 - first
```
public T first()
```
 Specified by:
 
 first in interface java.util.SortedSet<T>
 - last
```
public T last()
```
 Specified by:
 
 last in interface java.util.SortedSet<T>
 - getFirst
```
public T getFirst()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
 The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.
 
 Specified by:
 
 getFirst in interface com.gs.collections.api.RichIterable<T>
 - getLast
```
public T getLast()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
 The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.
 
 Specified by:
 
 getLast in interface com.gs.collections.api.RichIterable<T>
 - powerSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<com.gs.collections.api.set.sorted.SortedSetIterable<T>> powerSet()
```
 Description copied from interface: com.gs.collections.api.set.sorted.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 com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 powerSet in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - cartesianProduct
```
public  com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>> cartesianProduct(com.gs.collections.api.set.SetIterable set)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
 
 Specified by:
 
 cartesianProduct in interface com.gs.collections.api.set.SetIterable<T>
 - union
```
public TreeSortedSet<T> union(com.gs.collections.api.set.SetIterable<? extends T> set)
```
 Description copied from interface: com.gs.collections.api.set.sorted.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 com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 union in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 union in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - intersect
```
public TreeSortedSet<T> intersect(com.gs.collections.api.set.SetIterable<? extends T> set)
```
 Description copied from interface: com.gs.collections.api.set.sorted.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 this, not set.
 
 Specified by:
 
 intersect in interface com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 intersect in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 intersect in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - difference
```
public TreeSortedSet<T> difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet)
```
 Description copied from interface: com.gs.collections.api.set.sorted.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 com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 difference in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 difference in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - symmetricDifference
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB)
```
 Description copied from interface: com.gs.collections.api.set.sorted.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 com.gs.collections.api.set.SetIterable<T>
 
 Specified by:
 
 symmetricDifference in interface com.gs.collections.api.set.sorted.MutableSortedSet<T>
 
 Specified by:
 
 symmetricDifference in interface com.gs.collections.api.set.sorted.SortedSetIterable<T>
 - unionInto
```
public <R extends java.util.Set<T>> R unionInto(com.gs.collections.api.set.SetIterable<? extends T> set,
 R targetSet)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 unionInto in interface com.gs.collections.api.set.SetIterable<T>
 - intersectInto
```
public <R extends java.util.Set<T>> R intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set,
 R targetSet)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 intersectInto in interface com.gs.collections.api.set.SetIterable<T>
 - differenceInto
```
public <R extends java.util.Set<T>> R differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet,
 R targetSet)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 differenceInto in interface com.gs.collections.api.set.SetIterable<T>
 - symmetricDifferenceInto
```
public <R extends java.util.Set<T>> R symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set,
 R targetSet)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 symmetricDifferenceInto in interface com.gs.collections.api.set.SetIterable<T>
 - isSubsetOf
```
public boolean isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Returns true if all the members of this are also members of candidateSuperset. For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.
 
 Specified by:
 
 isSubsetOf in interface com.gs.collections.api.set.SetIterable<T>
 - isProperSubsetOf
```
public boolean isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)
```
 Description copied from interface: com.gs.collections.api.set.SetIterable
 
 Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal. For example, [1, 2] is a proper subset of [1, 2, 3], but [1, 2, 3] is not.
 
 Specified by:
 
 isProperSubsetOf in interface com.gs.collections.api.set.SetIterable<T>
 - iterator
```
public java.util.Iterator<T> iterator()
```
 Specified by:
 
 iterator in interface java.lang.Iterable<T>
 
 Specified by:
 
 iterator in interface java.util.Collection<T>
 
 Specified by:
 
 iterator in interface java.util.Set<T>
 - size
```
public int size()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the number of items in this iterable.
 
 Specified by:
 
 size in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 size in interface java.util.Collection<T>
 
 Specified by:
 
 size in interface java.util.Set<T>
 - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
 throws java.io.IOException
```
 Specified by:
 
 writeExternal in interface java.io.Externalizable
 
 Throws:
 
 java.io.IOException
 - readExternal
```
public void readExternal(java.io.ObjectInput in)
 throws java.io.IOException,
 java.lang.ClassNotFoundException
```
 Specified by:
 
 readExternal in interface java.io.Externalizable
 
 Throws:
 
 java.io.IOException
 
 java.lang.ClassNotFoundException
 - compareTo
```
public int compareTo(com.gs.collections.api.set.sorted.SortedSetIterable<T> otherSet)
```
 Specified by:
 
 compareTo in interface java.lang.Comparable<com.gs.collections.api.set.sorted.SortedSetIterable<T>>

Class TreeSortedSet<T>

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.collection.mutable.AbstractMutableCollection

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.gs.collections.api.ordered.SortedIterable

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

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

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

Methods inherited from interface java.util.Set

Constructor Detail

TreeSortedSet

TreeSortedSet

TreeSortedSet

TreeSortedSet

TreeSortedSet

Method Detail

newSet

newSet

newSet

newSet

newSetWith

newSetWith

asUnmodifiable

asSynchronized

asParallel

toImmutable

toStack

add

remove

addAll

contains

containsAll

clear

clone

equals

hashCode

with

with

with

with

without

withAll

withoutAll

newEmpty

forEach

select

reject

partition

partitionWith

partitionWhile

selectInstancesOf

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

flatCollect

collectIf

groupBy

groupByEach

groupByUniqueKey

selectWith

rejectWith

collectWith

zip

zipWithIndex

takeWhile

dropWhile

distinct

removeAllIterable

comparator

subSet

headSet

tailSet