Package org.organicdesign.fp.collections

Interface ImSortedSet<E>

All Superinterfaces:

BaseSet<E>, java.util.Collection<E>, java.lang.Iterable<E>, java.util.Set<E>, Sized, java.util.SortedSet<E>, Transformable<E>, UnmodCollection<E>, UnmodIterable<E>, UnmodSet<E>, UnmodSortedCollection<E>, UnmodSortedIterable<E>, UnmodSortedSet<E>

All Known Implementing Classes:

PersistentTreeSet

public interface ImSortedSet<E>
extends BaseSet<E>, UnmodSortedSet<E>

An immutable sorted set interface

Method Summary

Modifier and Type	Method	Description
default ImSortedSet<E>	headSet(E toElement)
UnmodSortedIterator<E>	iterator()	Iterates over contents in a guaranteed order.
ImSortedSet<E>	put(E e)	Adds an element.
ImSortedSet<E>	subSet(E fromElement, E toElement)	Return the elements in this set from the start element (inclusive) to the end element (exclusive)
ImSortedSet<E>	tailSet(E fromElement)
default ImSortedSet<E>	union(java.lang.Iterable<? extends E> iter)	Returns a new set containing all the items.
ImSortedSet<E>	without(E key)	Removes this key from the set

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

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

Methods inherited from interface org.organicdesign.fp.collections.Sized

size

Methods inherited from interface java.util.SortedSet

comparator, first, last, spliterator

Methods inherited from interface org.organicdesign.fp.xform.Transformable

toImList, toImMap, toImRrbt, toImSet, toImSortedMap, toImSortedSet, toMutableList, toMutableMap, toMutableRrbt, toMutableSet, toMutableSortedMap, toMutableSortedSet

Methods inherited from interface org.organicdesign.fp.collections.UnmodIterable

concat, drop, dropWhile, filter, flatMap, fold, foldUntil, head, map, precat, take, takeWhile

Methods inherited from interface org.organicdesign.fp.collections.UnmodSet

add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, removeIf, retainAll, toArray, toArray

Method Detail

put

ImSortedSet<E> put(E e)

Adds an element. If the element already exists in this set, the new value overwrites the old one. If the new element is the same as an old element (based on the address of that item in memory, not an equals test), the old set may be returned unchanged.

Specified by:

put in interface BaseSet<E>

Parameters:

e - the element to add to this set

Returns:

a new set with the element added (see note above about adding duplicate elements).

without

ImSortedSet<E> without(E key)

Removes this key from the set

Specified by:

without in interface BaseSet<E>

headSet

default ImSortedSet<E> headSet(E toElement)

Specified by:

headSet in interface java.util.SortedSet<E>

Specified by:

headSet in interface UnmodSortedSet<E>

iterator

UnmodSortedIterator<E> iterator()

Iterates over contents in a guaranteed order. Iterates over contents with no guarantees about their ordering. An unmodifiable iterator A one-time use, mutable, not-thread-safe way to get each value of the underling collection in turn. I experimented with various thread-safe alternatives, but the JVM is optimized around iterators so this is the lowest common denominator of collection iteration, even though iterators are inherently mutable.

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Set<E>

Specified by:

iterator in interface UnmodCollection<E>

Specified by:

iterator in interface UnmodIterable<E>

Specified by:

iterator in interface UnmodSet<E>

Specified by:

iterator in interface UnmodSortedCollection<E>

Specified by:

iterator in interface UnmodSortedIterable<E>

Specified by:

iterator in interface UnmodSortedSet<E>

subSet

ImSortedSet<E> subSet(E fromElement,
                      E toElement)

Return the elements in this set from the start element (inclusive) to the end element (exclusive)

Specified by:

subSet in interface java.util.SortedSet<E>

Specified by:

subSet in interface UnmodSortedSet<E>

tailSet

ImSortedSet<E> tailSet(E fromElement)

Specified by:

tailSet in interface java.util.SortedSet<E>

Specified by:

tailSet in interface UnmodSortedSet<E>

union

default ImSortedSet<E> union(java.lang.Iterable<? extends E> iter)

Description copied from interface: BaseSet

Returns a new set containing all the items.

Specified by:

union in interface BaseSet<E>