Package org.organicdesign.fp.collections

Interface ImSortedSet<E>

All Superinterfaces:

BaseSet<E>, Collection<E>, Iterable<E>, Set<E>, Sized, 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

Nested Class Summary

Nested classes/interfaces inherited from interface org.organicdesign.fp.collections.UnmodIterable

UnmodIterable.UnIterable

Method Summary

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

any, toImList, toImMap, toImRrbt, toImSet, toImSortedMap, toImSortedSet, toMutList, toMutMap, toMutRrbt, toMutSet, toMutSortedMap, toMutSortedSet

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

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

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

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

Method Detail

put

@NotNull
@NotNull 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

@NotNull
@NotNull ImSortedSet<E> without(E key)

Removes this key from the set

Specified by:

without in interface BaseSet<E>

headSet

@NotNull
default @NotNull ImSortedSet<E> headSet(E toElement)

Specified by:

headSet in interface SortedSet<E>

Specified by:

headSet in interface UnmodSortedSet<E>

iterator

@NotNull
@NotNull 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 Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface 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

@NotNull
@NotNull 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 SortedSet<E>

Specified by:

subSet in interface UnmodSortedSet<E>

tailSet

@NotNull
@NotNull ImSortedSet<E> tailSet(E fromElement)

Specified by:

tailSet in interface SortedSet<E>

Specified by:

tailSet in interface UnmodSortedSet<E>

union

@NotNull
default @NotNull ImSortedSet<E> union(@NotNull
                                      @NotNull Iterable<? extends E> iter)

Description copied from interface: BaseSet

Returns a new set containing all the items.

Specified by:

union in interface BaseSet<E>